<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.configuration;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.File;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.io.FilterWriter;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.io.IOException;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.io.LineNumberReader;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.io.Reader;<a name="line.24"></a>
<FONT color="green">025</FONT>    import java.io.Writer;<a name="line.25"></a>
<FONT color="green">026</FONT>    import java.net.URL;<a name="line.26"></a>
<FONT color="green">027</FONT>    import java.util.ArrayList;<a name="line.27"></a>
<FONT color="green">028</FONT>    import java.util.Iterator;<a name="line.28"></a>
<FONT color="green">029</FONT>    import java.util.List;<a name="line.29"></a>
<FONT color="green">030</FONT>    import java.util.regex.Matcher;<a name="line.30"></a>
<FONT color="green">031</FONT>    import java.util.regex.Pattern;<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>    import org.apache.commons.lang.ArrayUtils;<a name="line.33"></a>
<FONT color="green">034</FONT>    import org.apache.commons.lang.StringEscapeUtils;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.apache.commons.lang.StringUtils;<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>    /**<a name="line.37"></a>
<FONT color="green">038</FONT>     * This is the "classic" Properties loader which loads the values from<a name="line.38"></a>
<FONT color="green">039</FONT>     * a single or multiple files (which can be chained with "include =".<a name="line.39"></a>
<FONT color="green">040</FONT>     * All given path references are either absolute or relative to the<a name="line.40"></a>
<FONT color="green">041</FONT>     * file name supplied in the constructor.<a name="line.41"></a>
<FONT color="green">042</FONT>     * &lt;p&gt;<a name="line.42"></a>
<FONT color="green">043</FONT>     * In this class, empty PropertyConfigurations can be built, properties<a name="line.43"></a>
<FONT color="green">044</FONT>     * added and later saved. include statements are (obviously) not supported<a name="line.44"></a>
<FONT color="green">045</FONT>     * if you don't construct a PropertyConfiguration from a file.<a name="line.45"></a>
<FONT color="green">046</FONT>     *<a name="line.46"></a>
<FONT color="green">047</FONT>     * &lt;p&gt;The properties file syntax is explained here, basically it follows<a name="line.47"></a>
<FONT color="green">048</FONT>     * the syntax of the stream parsed by {@link java.util.Properties#load} and<a name="line.48"></a>
<FONT color="green">049</FONT>     * adds several useful extensions:<a name="line.49"></a>
<FONT color="green">050</FONT>     *<a name="line.50"></a>
<FONT color="green">051</FONT>     * &lt;ul&gt;<a name="line.51"></a>
<FONT color="green">052</FONT>     *  &lt;li&gt;<a name="line.52"></a>
<FONT color="green">053</FONT>     *   Each property has the syntax &lt;code&gt;key &amp;lt;separator&gt; value&lt;/code&gt;. The<a name="line.53"></a>
<FONT color="green">054</FONT>     *   separators accepted are {@code '='}, {@code ':'} and any white<a name="line.54"></a>
<FONT color="green">055</FONT>     *   space character. Examples:<a name="line.55"></a>
<FONT color="green">056</FONT>     * &lt;pre&gt;<a name="line.56"></a>
<FONT color="green">057</FONT>     *  key1 = value1<a name="line.57"></a>
<FONT color="green">058</FONT>     *  key2 : value2<a name="line.58"></a>
<FONT color="green">059</FONT>     *  key3   value3&lt;/pre&gt;<a name="line.59"></a>
<FONT color="green">060</FONT>     *  &lt;/li&gt;<a name="line.60"></a>
<FONT color="green">061</FONT>     *  &lt;li&gt;<a name="line.61"></a>
<FONT color="green">062</FONT>     *   The &lt;i&gt;key&lt;/i&gt; may use any character, separators must be escaped:<a name="line.62"></a>
<FONT color="green">063</FONT>     * &lt;pre&gt;<a name="line.63"></a>
<FONT color="green">064</FONT>     *  key\:foo = bar&lt;/pre&gt;<a name="line.64"></a>
<FONT color="green">065</FONT>     *  &lt;/li&gt;<a name="line.65"></a>
<FONT color="green">066</FONT>     *  &lt;li&gt;<a name="line.66"></a>
<FONT color="green">067</FONT>     *   &lt;i&gt;value&lt;/i&gt; may be separated on different lines if a backslash<a name="line.67"></a>
<FONT color="green">068</FONT>     *   is placed at the end of the line that continues below.<a name="line.68"></a>
<FONT color="green">069</FONT>     *  &lt;/li&gt;<a name="line.69"></a>
<FONT color="green">070</FONT>     *  &lt;li&gt;<a name="line.70"></a>
<FONT color="green">071</FONT>     *   &lt;i&gt;value&lt;/i&gt; can contain &lt;em&gt;value delimiters&lt;/em&gt; and will then be interpreted<a name="line.71"></a>
<FONT color="green">072</FONT>     *   as a list of tokens. Default value delimiter is the comma ','. So the<a name="line.72"></a>
<FONT color="green">073</FONT>     *   following property definition<a name="line.73"></a>
<FONT color="green">074</FONT>     * &lt;pre&gt;<a name="line.74"></a>
<FONT color="green">075</FONT>     *  key = This property, has multiple, values<a name="line.75"></a>
<FONT color="green">076</FONT>     * &lt;/pre&gt;<a name="line.76"></a>
<FONT color="green">077</FONT>     *   will result in a property with three values. You can change the value<a name="line.77"></a>
<FONT color="green">078</FONT>     *   delimiter using the {@link AbstractConfiguration#setListDelimiter(char)}<a name="line.78"></a>
<FONT color="green">079</FONT>     *   method. Setting the delimiter to 0 will disable value splitting completely.<a name="line.79"></a>
<FONT color="green">080</FONT>     *  &lt;/li&gt;<a name="line.80"></a>
<FONT color="green">081</FONT>     *  &lt;li&gt;<a name="line.81"></a>
<FONT color="green">082</FONT>     *   Commas in each token are escaped placing a backslash right before<a name="line.82"></a>
<FONT color="green">083</FONT>     *   the comma.<a name="line.83"></a>
<FONT color="green">084</FONT>     *  &lt;/li&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>     *  &lt;li&gt;<a name="line.85"></a>
<FONT color="green">086</FONT>     *   If a &lt;i&gt;key&lt;/i&gt; is used more than once, the values are appended<a name="line.86"></a>
<FONT color="green">087</FONT>     *   like if they were on the same line separated with commas. &lt;em&gt;Note&lt;/em&gt;:<a name="line.87"></a>
<FONT color="green">088</FONT>     *   When the configuration file is written back to disk the associated<a name="line.88"></a>
<FONT color="green">089</FONT>     *   {@link PropertiesConfigurationLayout} object (see below) will<a name="line.89"></a>
<FONT color="green">090</FONT>     *   try to preserve as much of the original format as possible, i.e. properties<a name="line.90"></a>
<FONT color="green">091</FONT>     *   with multiple values defined on a single line will also be written back on<a name="line.91"></a>
<FONT color="green">092</FONT>     *   a single line, and multiple occurrences of a single key will be written on<a name="line.92"></a>
<FONT color="green">093</FONT>     *   multiple lines. If the {@code addProperty()} method was called<a name="line.93"></a>
<FONT color="green">094</FONT>     *   multiple times for adding multiple values to a property, these properties<a name="line.94"></a>
<FONT color="green">095</FONT>     *   will per default be written on multiple lines in the output file, too.<a name="line.95"></a>
<FONT color="green">096</FONT>     *   Some options of the {@code PropertiesConfigurationLayout} class have<a name="line.96"></a>
<FONT color="green">097</FONT>     *   influence on that behavior.<a name="line.97"></a>
<FONT color="green">098</FONT>     *  &lt;/li&gt;<a name="line.98"></a>
<FONT color="green">099</FONT>     *  &lt;li&gt;<a name="line.99"></a>
<FONT color="green">100</FONT>     *   Blank lines and lines starting with character '#' or '!' are skipped.<a name="line.100"></a>
<FONT color="green">101</FONT>     *  &lt;/li&gt;<a name="line.101"></a>
<FONT color="green">102</FONT>     *  &lt;li&gt;<a name="line.102"></a>
<FONT color="green">103</FONT>     *   If a property is named "include" (or whatever is defined by<a name="line.103"></a>
<FONT color="green">104</FONT>     *   setInclude() and getInclude() and the value of that property is<a name="line.104"></a>
<FONT color="green">105</FONT>     *   the full path to a file on disk, that file will be included into<a name="line.105"></a>
<FONT color="green">106</FONT>     *   the configuration. You can also pull in files relative to the parent<a name="line.106"></a>
<FONT color="green">107</FONT>     *   configuration file. So if you have something like the following:<a name="line.107"></a>
<FONT color="green">108</FONT>     *<a name="line.108"></a>
<FONT color="green">109</FONT>     *   include = additional.properties<a name="line.109"></a>
<FONT color="green">110</FONT>     *<a name="line.110"></a>
<FONT color="green">111</FONT>     *   Then "additional.properties" is expected to be in the same<a name="line.111"></a>
<FONT color="green">112</FONT>     *   directory as the parent configuration file.<a name="line.112"></a>
<FONT color="green">113</FONT>     *<a name="line.113"></a>
<FONT color="green">114</FONT>     *   The properties in the included file are added to the parent configuration,<a name="line.114"></a>
<FONT color="green">115</FONT>     *   they do not replace existing properties with the same key.<a name="line.115"></a>
<FONT color="green">116</FONT>     *<a name="line.116"></a>
<FONT color="green">117</FONT>     *  &lt;/li&gt;<a name="line.117"></a>
<FONT color="green">118</FONT>     * &lt;/ul&gt;<a name="line.118"></a>
<FONT color="green">119</FONT>     *<a name="line.119"></a>
<FONT color="green">120</FONT>     * &lt;p&gt;Here is an example of a valid extended properties file:<a name="line.120"></a>
<FONT color="green">121</FONT>     *<a name="line.121"></a>
<FONT color="green">122</FONT>     * &lt;p&gt;&lt;pre&gt;<a name="line.122"></a>
<FONT color="green">123</FONT>     *      # lines starting with # are comments<a name="line.123"></a>
<FONT color="green">124</FONT>     *<a name="line.124"></a>
<FONT color="green">125</FONT>     *      # This is the simplest property<a name="line.125"></a>
<FONT color="green">126</FONT>     *      key = value<a name="line.126"></a>
<FONT color="green">127</FONT>     *<a name="line.127"></a>
<FONT color="green">128</FONT>     *      # A long property may be separated on multiple lines<a name="line.128"></a>
<FONT color="green">129</FONT>     *      longvalue = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \<a name="line.129"></a>
<FONT color="green">130</FONT>     *                  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa<a name="line.130"></a>
<FONT color="green">131</FONT>     *<a name="line.131"></a>
<FONT color="green">132</FONT>     *      # This is a property with many tokens<a name="line.132"></a>
<FONT color="green">133</FONT>     *      tokens_on_a_line = first token, second token<a name="line.133"></a>
<FONT color="green">134</FONT>     *<a name="line.134"></a>
<FONT color="green">135</FONT>     *      # This sequence generates exactly the same result<a name="line.135"></a>
<FONT color="green">136</FONT>     *      tokens_on_multiple_lines = first token<a name="line.136"></a>
<FONT color="green">137</FONT>     *      tokens_on_multiple_lines = second token<a name="line.137"></a>
<FONT color="green">138</FONT>     *<a name="line.138"></a>
<FONT color="green">139</FONT>     *      # commas may be escaped in tokens<a name="line.139"></a>
<FONT color="green">140</FONT>     *      commas.escaped = Hi\, what'up?<a name="line.140"></a>
<FONT color="green">141</FONT>     *<a name="line.141"></a>
<FONT color="green">142</FONT>     *      # properties can reference other properties<a name="line.142"></a>
<FONT color="green">143</FONT>     *      base.prop = /base<a name="line.143"></a>
<FONT color="green">144</FONT>     *      first.prop = ${base.prop}/first<a name="line.144"></a>
<FONT color="green">145</FONT>     *      second.prop = ${first.prop}/second<a name="line.145"></a>
<FONT color="green">146</FONT>     * &lt;/pre&gt;<a name="line.146"></a>
<FONT color="green">147</FONT>     *<a name="line.147"></a>
<FONT color="green">148</FONT>     * &lt;p&gt;A {@code PropertiesConfiguration} object is associated with an<a name="line.148"></a>
<FONT color="green">149</FONT>     * instance of the {@link PropertiesConfigurationLayout} class,<a name="line.149"></a>
<FONT color="green">150</FONT>     * which is responsible for storing the layout of the parsed properties file<a name="line.150"></a>
<FONT color="green">151</FONT>     * (i.e. empty lines, comments, and such things). The {@code getLayout()}<a name="line.151"></a>
<FONT color="green">152</FONT>     * method can be used to obtain this layout object. With {@code setLayout()}<a name="line.152"></a>
<FONT color="green">153</FONT>     * a new layout object can be set. This should be done before a properties file<a name="line.153"></a>
<FONT color="green">154</FONT>     * was loaded.<a name="line.154"></a>
<FONT color="green">155</FONT>     * &lt;p&gt;&lt;em&gt;Note:&lt;/em&gt;Configuration objects of this type can be read concurrently<a name="line.155"></a>
<FONT color="green">156</FONT>     * by multiple threads. However if one of these threads modifies the object,<a name="line.156"></a>
<FONT color="green">157</FONT>     * synchronization has to be performed manually.<a name="line.157"></a>
<FONT color="green">158</FONT>     *<a name="line.158"></a>
<FONT color="green">159</FONT>     * @see java.util.Properties#load<a name="line.159"></a>
<FONT color="green">160</FONT>     *<a name="line.160"></a>
<FONT color="green">161</FONT>     * @author &lt;a href="mailto:stefano@apache.org"&gt;Stefano Mazzocchi&lt;/a&gt;<a name="line.161"></a>
<FONT color="green">162</FONT>     * @author &lt;a href="mailto:jon@latchkey.com"&gt;Jon S. Stevens&lt;/a&gt;<a name="line.162"></a>
<FONT color="green">163</FONT>     * @author &lt;a href="mailto:daveb@miceda-data"&gt;Dave Bryson&lt;/a&gt;<a name="line.163"></a>
<FONT color="green">164</FONT>     * @author &lt;a href="mailto:geirm@optonline.net"&gt;Geir Magnusson Jr.&lt;/a&gt;<a name="line.164"></a>
<FONT color="green">165</FONT>     * @author &lt;a href="mailto:leon@opticode.co.za"&gt;Leon Messerschmidt&lt;/a&gt;<a name="line.165"></a>
<FONT color="green">166</FONT>     * @author &lt;a href="mailto:kjohnson@transparent.com"&gt;Kent Johnson&lt;/a&gt;<a name="line.166"></a>
<FONT color="green">167</FONT>     * @author &lt;a href="mailto:dlr@finemaltcoding.com"&gt;Daniel Rall&lt;/a&gt;<a name="line.167"></a>
<FONT color="green">168</FONT>     * @author &lt;a href="mailto:ipriha@surfeu.fi"&gt;Ilkka Priha&lt;/a&gt;<a name="line.168"></a>
<FONT color="green">169</FONT>     * @author &lt;a href="mailto:jvanzyl@apache.org"&gt;Jason van Zyl&lt;/a&gt;<a name="line.169"></a>
<FONT color="green">170</FONT>     * @author &lt;a href="mailto:mpoeschl@marmot.at"&gt;Martin Poeschl&lt;/a&gt;<a name="line.170"></a>
<FONT color="green">171</FONT>     * @author &lt;a href="mailto:hps@intermeta.de"&gt;Henning P. Schmiedehausen&lt;/a&gt;<a name="line.171"></a>
<FONT color="green">172</FONT>     * @author &lt;a href="mailto:epugh@upstate.com"&gt;Eric Pugh&lt;/a&gt;<a name="line.172"></a>
<FONT color="green">173</FONT>     * @author &lt;a href="mailto:ebourg@apache.org"&gt;Emmanuel Bourg&lt;/a&gt;<a name="line.173"></a>
<FONT color="green">174</FONT>     * @version $Id: PropertiesConfiguration.java 1234985 2012-01-23 21:09:09Z oheger $<a name="line.174"></a>
<FONT color="green">175</FONT>     */<a name="line.175"></a>
<FONT color="green">176</FONT>    public class PropertiesConfiguration extends AbstractFileConfiguration<a name="line.176"></a>
<FONT color="green">177</FONT>    {<a name="line.177"></a>
<FONT color="green">178</FONT>        /** Constant for the supported comment characters.*/<a name="line.178"></a>
<FONT color="green">179</FONT>        static final String COMMENT_CHARS = "#!";<a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>        /** Constant for the default properties separator.*/<a name="line.181"></a>
<FONT color="green">182</FONT>        static final String DEFAULT_SEPARATOR = " = ";<a name="line.182"></a>
<FONT color="green">183</FONT>    <a name="line.183"></a>
<FONT color="green">184</FONT>        /**<a name="line.184"></a>
<FONT color="green">185</FONT>         * Constant for the default {@code IOFactory}. This instance is used<a name="line.185"></a>
<FONT color="green">186</FONT>         * when no specific factory was set.<a name="line.186"></a>
<FONT color="green">187</FONT>         */<a name="line.187"></a>
<FONT color="green">188</FONT>        private static final IOFactory DEFAULT_IO_FACTORY = new DefaultIOFactory();<a name="line.188"></a>
<FONT color="green">189</FONT>    <a name="line.189"></a>
<FONT color="green">190</FONT>        /**<a name="line.190"></a>
<FONT color="green">191</FONT>         * This is the name of the property that can point to other<a name="line.191"></a>
<FONT color="green">192</FONT>         * properties file for including other properties files.<a name="line.192"></a>
<FONT color="green">193</FONT>         */<a name="line.193"></a>
<FONT color="green">194</FONT>        private static String include = "include";<a name="line.194"></a>
<FONT color="green">195</FONT>    <a name="line.195"></a>
<FONT color="green">196</FONT>        /** The list of possible key/value separators */<a name="line.196"></a>
<FONT color="green">197</FONT>        private static final char[] SEPARATORS = new char[] {'=', ':'};<a name="line.197"></a>
<FONT color="green">198</FONT>    <a name="line.198"></a>
<FONT color="green">199</FONT>        /** The white space characters used as key/value separators. */<a name="line.199"></a>
<FONT color="green">200</FONT>        private static final char[] WHITE_SPACE = new char[]{' ', '\t', '\f'};<a name="line.200"></a>
<FONT color="green">201</FONT>    <a name="line.201"></a>
<FONT color="green">202</FONT>        /**<a name="line.202"></a>
<FONT color="green">203</FONT>         * The default encoding (ISO-8859-1 as specified by<a name="line.203"></a>
<FONT color="green">204</FONT>         * http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html)<a name="line.204"></a>
<FONT color="green">205</FONT>         */<a name="line.205"></a>
<FONT color="green">206</FONT>        private static final String DEFAULT_ENCODING = "ISO-8859-1";<a name="line.206"></a>
<FONT color="green">207</FONT>    <a name="line.207"></a>
<FONT color="green">208</FONT>        /** Constant for the platform specific line separator.*/<a name="line.208"></a>
<FONT color="green">209</FONT>        private static final String LINE_SEPARATOR = System.getProperty("line.separator");<a name="line.209"></a>
<FONT color="green">210</FONT>    <a name="line.210"></a>
<FONT color="green">211</FONT>        /** Constant for the escaping character.*/<a name="line.211"></a>
<FONT color="green">212</FONT>        private static final String ESCAPE = "\\";<a name="line.212"></a>
<FONT color="green">213</FONT>    <a name="line.213"></a>
<FONT color="green">214</FONT>        /** Constant for the escaped escaping character.*/<a name="line.214"></a>
<FONT color="green">215</FONT>        private static final String DOUBLE_ESC = ESCAPE + ESCAPE;<a name="line.215"></a>
<FONT color="green">216</FONT>    <a name="line.216"></a>
<FONT color="green">217</FONT>        /** Constant for the radix of hex numbers.*/<a name="line.217"></a>
<FONT color="green">218</FONT>        private static final int HEX_RADIX = 16;<a name="line.218"></a>
<FONT color="green">219</FONT>    <a name="line.219"></a>
<FONT color="green">220</FONT>        /** Constant for the length of a unicode literal.*/<a name="line.220"></a>
<FONT color="green">221</FONT>        private static final int UNICODE_LEN = 4;<a name="line.221"></a>
<FONT color="green">222</FONT>    <a name="line.222"></a>
<FONT color="green">223</FONT>        /** Stores the layout object.*/<a name="line.223"></a>
<FONT color="green">224</FONT>        private PropertiesConfigurationLayout layout;<a name="line.224"></a>
<FONT color="green">225</FONT>    <a name="line.225"></a>
<FONT color="green">226</FONT>        /** The IOFactory for creating readers and writers.*/<a name="line.226"></a>
<FONT color="green">227</FONT>        private volatile IOFactory ioFactory;<a name="line.227"></a>
<FONT color="green">228</FONT>    <a name="line.228"></a>
<FONT color="green">229</FONT>        /** Allow file inclusion or not */<a name="line.229"></a>
<FONT color="green">230</FONT>        private boolean includesAllowed;<a name="line.230"></a>
<FONT color="green">231</FONT>    <a name="line.231"></a>
<FONT color="green">232</FONT>        /**<a name="line.232"></a>
<FONT color="green">233</FONT>         * Creates an empty PropertyConfiguration object which can be<a name="line.233"></a>
<FONT color="green">234</FONT>         * used to synthesize a new Properties file by adding values and<a name="line.234"></a>
<FONT color="green">235</FONT>         * then saving().<a name="line.235"></a>
<FONT color="green">236</FONT>         */<a name="line.236"></a>
<FONT color="green">237</FONT>        public PropertiesConfiguration()<a name="line.237"></a>
<FONT color="green">238</FONT>        {<a name="line.238"></a>
<FONT color="green">239</FONT>            layout = createLayout();<a name="line.239"></a>
<FONT color="green">240</FONT>            setIncludesAllowed(false);<a name="line.240"></a>
<FONT color="green">241</FONT>        }<a name="line.241"></a>
<FONT color="green">242</FONT>    <a name="line.242"></a>
<FONT color="green">243</FONT>        /**<a name="line.243"></a>
<FONT color="green">244</FONT>         * Creates and loads the extended properties from the specified file.<a name="line.244"></a>
<FONT color="green">245</FONT>         * The specified file can contain "include = " properties which then<a name="line.245"></a>
<FONT color="green">246</FONT>         * are loaded and merged into the properties.<a name="line.246"></a>
<FONT color="green">247</FONT>         *<a name="line.247"></a>
<FONT color="green">248</FONT>         * @param fileName The name of the properties file to load.<a name="line.248"></a>
<FONT color="green">249</FONT>         * @throws ConfigurationException Error while loading the properties file<a name="line.249"></a>
<FONT color="green">250</FONT>         */<a name="line.250"></a>
<FONT color="green">251</FONT>        public PropertiesConfiguration(String fileName) throws ConfigurationException<a name="line.251"></a>
<FONT color="green">252</FONT>        {<a name="line.252"></a>
<FONT color="green">253</FONT>            super(fileName);<a name="line.253"></a>
<FONT color="green">254</FONT>        }<a name="line.254"></a>
<FONT color="green">255</FONT>    <a name="line.255"></a>
<FONT color="green">256</FONT>        /**<a name="line.256"></a>
<FONT color="green">257</FONT>         * Creates and loads the extended properties from the specified file.<a name="line.257"></a>
<FONT color="green">258</FONT>         * The specified file can contain "include = " properties which then<a name="line.258"></a>
<FONT color="green">259</FONT>         * are loaded and merged into the properties. If the file does not exist,<a name="line.259"></a>
<FONT color="green">260</FONT>         * an empty configuration will be created. Later the {@code save()}<a name="line.260"></a>
<FONT color="green">261</FONT>         * method can be called to save the properties to the specified file.<a name="line.261"></a>
<FONT color="green">262</FONT>         *<a name="line.262"></a>
<FONT color="green">263</FONT>         * @param file The properties file to load.<a name="line.263"></a>
<FONT color="green">264</FONT>         * @throws ConfigurationException Error while loading the properties file<a name="line.264"></a>
<FONT color="green">265</FONT>         */<a name="line.265"></a>
<FONT color="green">266</FONT>        public PropertiesConfiguration(File file) throws ConfigurationException<a name="line.266"></a>
<FONT color="green">267</FONT>        {<a name="line.267"></a>
<FONT color="green">268</FONT>            super(file);<a name="line.268"></a>
<FONT color="green">269</FONT>    <a name="line.269"></a>
<FONT color="green">270</FONT>            // If the file does not exist, no layout object was created. We have to<a name="line.270"></a>
<FONT color="green">271</FONT>            // do this manually in this case.<a name="line.271"></a>
<FONT color="green">272</FONT>            getLayout();<a name="line.272"></a>
<FONT color="green">273</FONT>        }<a name="line.273"></a>
<FONT color="green">274</FONT>    <a name="line.274"></a>
<FONT color="green">275</FONT>        /**<a name="line.275"></a>
<FONT color="green">276</FONT>         * Creates and loads the extended properties from the specified URL.<a name="line.276"></a>
<FONT color="green">277</FONT>         * The specified file can contain "include = " properties which then<a name="line.277"></a>
<FONT color="green">278</FONT>         * are loaded and merged into the properties.<a name="line.278"></a>
<FONT color="green">279</FONT>         *<a name="line.279"></a>
<FONT color="green">280</FONT>         * @param url The location of the properties file to load.<a name="line.280"></a>
<FONT color="green">281</FONT>         * @throws ConfigurationException Error while loading the properties file<a name="line.281"></a>
<FONT color="green">282</FONT>         */<a name="line.282"></a>
<FONT color="green">283</FONT>        public PropertiesConfiguration(URL url) throws ConfigurationException<a name="line.283"></a>
<FONT color="green">284</FONT>        {<a name="line.284"></a>
<FONT color="green">285</FONT>            super(url);<a name="line.285"></a>
<FONT color="green">286</FONT>        }<a name="line.286"></a>
<FONT color="green">287</FONT>    <a name="line.287"></a>
<FONT color="green">288</FONT>        /**<a name="line.288"></a>
<FONT color="green">289</FONT>         * Gets the property value for including other properties files.<a name="line.289"></a>
<FONT color="green">290</FONT>         * By default it is "include".<a name="line.290"></a>
<FONT color="green">291</FONT>         *<a name="line.291"></a>
<FONT color="green">292</FONT>         * @return A String.<a name="line.292"></a>
<FONT color="green">293</FONT>         */<a name="line.293"></a>
<FONT color="green">294</FONT>        public static String getInclude()<a name="line.294"></a>
<FONT color="green">295</FONT>        {<a name="line.295"></a>
<FONT color="green">296</FONT>            return PropertiesConfiguration.include;<a name="line.296"></a>
<FONT color="green">297</FONT>        }<a name="line.297"></a>
<FONT color="green">298</FONT>    <a name="line.298"></a>
<FONT color="green">299</FONT>        /**<a name="line.299"></a>
<FONT color="green">300</FONT>         * Sets the property value for including other properties files.<a name="line.300"></a>
<FONT color="green">301</FONT>         * By default it is "include".<a name="line.301"></a>
<FONT color="green">302</FONT>         *<a name="line.302"></a>
<FONT color="green">303</FONT>         * @param inc A String.<a name="line.303"></a>
<FONT color="green">304</FONT>         */<a name="line.304"></a>
<FONT color="green">305</FONT>        public static void setInclude(String inc)<a name="line.305"></a>
<FONT color="green">306</FONT>        {<a name="line.306"></a>
<FONT color="green">307</FONT>            PropertiesConfiguration.include = inc;<a name="line.307"></a>
<FONT color="green">308</FONT>        }<a name="line.308"></a>
<FONT color="green">309</FONT>    <a name="line.309"></a>
<FONT color="green">310</FONT>        /**<a name="line.310"></a>
<FONT color="green">311</FONT>         * Controls whether additional files can be loaded by the include = &lt;xxx&gt;<a name="line.311"></a>
<FONT color="green">312</FONT>         * statement or not. Base rule is, that objects created by the empty<a name="line.312"></a>
<FONT color="green">313</FONT>         * C'tor can not have included files.<a name="line.313"></a>
<FONT color="green">314</FONT>         *<a name="line.314"></a>
<FONT color="green">315</FONT>         * @param includesAllowed includesAllowed True if Includes are allowed.<a name="line.315"></a>
<FONT color="green">316</FONT>         */<a name="line.316"></a>
<FONT color="green">317</FONT>        protected void setIncludesAllowed(boolean includesAllowed)<a name="line.317"></a>
<FONT color="green">318</FONT>        {<a name="line.318"></a>
<FONT color="green">319</FONT>            this.includesAllowed = includesAllowed;<a name="line.319"></a>
<FONT color="green">320</FONT>        }<a name="line.320"></a>
<FONT color="green">321</FONT>    <a name="line.321"></a>
<FONT color="green">322</FONT>        /**<a name="line.322"></a>
<FONT color="green">323</FONT>         * Reports the status of file inclusion.<a name="line.323"></a>
<FONT color="green">324</FONT>         *<a name="line.324"></a>
<FONT color="green">325</FONT>         * @return True if include files are loaded.<a name="line.325"></a>
<FONT color="green">326</FONT>         */<a name="line.326"></a>
<FONT color="green">327</FONT>        public boolean getIncludesAllowed()<a name="line.327"></a>
<FONT color="green">328</FONT>        {<a name="line.328"></a>
<FONT color="green">329</FONT>            return this.includesAllowed;<a name="line.329"></a>
<FONT color="green">330</FONT>        }<a name="line.330"></a>
<FONT color="green">331</FONT>    <a name="line.331"></a>
<FONT color="green">332</FONT>        /**<a name="line.332"></a>
<FONT color="green">333</FONT>         * Return the comment header.<a name="line.333"></a>
<FONT color="green">334</FONT>         *<a name="line.334"></a>
<FONT color="green">335</FONT>         * @return the comment header<a name="line.335"></a>
<FONT color="green">336</FONT>         * @since 1.1<a name="line.336"></a>
<FONT color="green">337</FONT>         */<a name="line.337"></a>
<FONT color="green">338</FONT>        public String getHeader()<a name="line.338"></a>
<FONT color="green">339</FONT>        {<a name="line.339"></a>
<FONT color="green">340</FONT>            return getLayout().getHeaderComment();<a name="line.340"></a>
<FONT color="green">341</FONT>        }<a name="line.341"></a>
<FONT color="green">342</FONT>    <a name="line.342"></a>
<FONT color="green">343</FONT>        /**<a name="line.343"></a>
<FONT color="green">344</FONT>         * Set the comment header.<a name="line.344"></a>
<FONT color="green">345</FONT>         *<a name="line.345"></a>
<FONT color="green">346</FONT>         * @param header the header to use<a name="line.346"></a>
<FONT color="green">347</FONT>         * @since 1.1<a name="line.347"></a>
<FONT color="green">348</FONT>         */<a name="line.348"></a>
<FONT color="green">349</FONT>        public void setHeader(String header)<a name="line.349"></a>
<FONT color="green">350</FONT>        {<a name="line.350"></a>
<FONT color="green">351</FONT>            getLayout().setHeaderComment(header);<a name="line.351"></a>
<FONT color="green">352</FONT>        }<a name="line.352"></a>
<FONT color="green">353</FONT>    <a name="line.353"></a>
<FONT color="green">354</FONT>        /**<a name="line.354"></a>
<FONT color="green">355</FONT>         * Returns the encoding to be used when loading or storing configuration<a name="line.355"></a>
<FONT color="green">356</FONT>         * data. This implementation ensures that the default encoding will be used<a name="line.356"></a>
<FONT color="green">357</FONT>         * if none has been set explicitly.<a name="line.357"></a>
<FONT color="green">358</FONT>         *<a name="line.358"></a>
<FONT color="green">359</FONT>         * @return the encoding<a name="line.359"></a>
<FONT color="green">360</FONT>         */<a name="line.360"></a>
<FONT color="green">361</FONT>        @Override<a name="line.361"></a>
<FONT color="green">362</FONT>        public String getEncoding()<a name="line.362"></a>
<FONT color="green">363</FONT>        {<a name="line.363"></a>
<FONT color="green">364</FONT>            String enc = super.getEncoding();<a name="line.364"></a>
<FONT color="green">365</FONT>            return (enc != null) ? enc : DEFAULT_ENCODING;<a name="line.365"></a>
<FONT color="green">366</FONT>        }<a name="line.366"></a>
<FONT color="green">367</FONT>    <a name="line.367"></a>
<FONT color="green">368</FONT>        /**<a name="line.368"></a>
<FONT color="green">369</FONT>         * Returns the associated layout object.<a name="line.369"></a>
<FONT color="green">370</FONT>         *<a name="line.370"></a>
<FONT color="green">371</FONT>         * @return the associated layout object<a name="line.371"></a>
<FONT color="green">372</FONT>         * @since 1.3<a name="line.372"></a>
<FONT color="green">373</FONT>         */<a name="line.373"></a>
<FONT color="green">374</FONT>        public synchronized PropertiesConfigurationLayout getLayout()<a name="line.374"></a>
<FONT color="green">375</FONT>        {<a name="line.375"></a>
<FONT color="green">376</FONT>            if (layout == null)<a name="line.376"></a>
<FONT color="green">377</FONT>            {<a name="line.377"></a>
<FONT color="green">378</FONT>                layout = createLayout();<a name="line.378"></a>
<FONT color="green">379</FONT>            }<a name="line.379"></a>
<FONT color="green">380</FONT>            return layout;<a name="line.380"></a>
<FONT color="green">381</FONT>        }<a name="line.381"></a>
<FONT color="green">382</FONT>    <a name="line.382"></a>
<FONT color="green">383</FONT>        /**<a name="line.383"></a>
<FONT color="green">384</FONT>         * Sets the associated layout object.<a name="line.384"></a>
<FONT color="green">385</FONT>         *<a name="line.385"></a>
<FONT color="green">386</FONT>         * @param layout the new layout object; can be &lt;b&gt;null&lt;/b&gt;, then a new<a name="line.386"></a>
<FONT color="green">387</FONT>         * layout object will be created<a name="line.387"></a>
<FONT color="green">388</FONT>         * @since 1.3<a name="line.388"></a>
<FONT color="green">389</FONT>         */<a name="line.389"></a>
<FONT color="green">390</FONT>        public synchronized void setLayout(PropertiesConfigurationLayout layout)<a name="line.390"></a>
<FONT color="green">391</FONT>        {<a name="line.391"></a>
<FONT color="green">392</FONT>            // only one layout must exist<a name="line.392"></a>
<FONT color="green">393</FONT>            if (this.layout != null)<a name="line.393"></a>
<FONT color="green">394</FONT>            {<a name="line.394"></a>
<FONT color="green">395</FONT>                removeConfigurationListener(this.layout);<a name="line.395"></a>
<FONT color="green">396</FONT>            }<a name="line.396"></a>
<FONT color="green">397</FONT>    <a name="line.397"></a>
<FONT color="green">398</FONT>            if (layout == null)<a name="line.398"></a>
<FONT color="green">399</FONT>            {<a name="line.399"></a>
<FONT color="green">400</FONT>                this.layout = createLayout();<a name="line.400"></a>
<FONT color="green">401</FONT>            }<a name="line.401"></a>
<FONT color="green">402</FONT>            else<a name="line.402"></a>
<FONT color="green">403</FONT>            {<a name="line.403"></a>
<FONT color="green">404</FONT>                this.layout = layout;<a name="line.404"></a>
<FONT color="green">405</FONT>            }<a name="line.405"></a>
<FONT color="green">406</FONT>        }<a name="line.406"></a>
<FONT color="green">407</FONT>    <a name="line.407"></a>
<FONT color="green">408</FONT>        /**<a name="line.408"></a>
<FONT color="green">409</FONT>         * Creates the associated layout object. This method is invoked when the<a name="line.409"></a>
<FONT color="green">410</FONT>         * layout object is accessed and has not been created yet. Derived classes<a name="line.410"></a>
<FONT color="green">411</FONT>         * can override this method to hook in a different layout implementation.<a name="line.411"></a>
<FONT color="green">412</FONT>         *<a name="line.412"></a>
<FONT color="green">413</FONT>         * @return the layout object to use<a name="line.413"></a>
<FONT color="green">414</FONT>         * @since 1.3<a name="line.414"></a>
<FONT color="green">415</FONT>         */<a name="line.415"></a>
<FONT color="green">416</FONT>        protected PropertiesConfigurationLayout createLayout()<a name="line.416"></a>
<FONT color="green">417</FONT>        {<a name="line.417"></a>
<FONT color="green">418</FONT>            return new PropertiesConfigurationLayout(this);<a name="line.418"></a>
<FONT color="green">419</FONT>        }<a name="line.419"></a>
<FONT color="green">420</FONT>    <a name="line.420"></a>
<FONT color="green">421</FONT>        /**<a name="line.421"></a>
<FONT color="green">422</FONT>         * Returns the {@code IOFactory} to be used for creating readers and<a name="line.422"></a>
<FONT color="green">423</FONT>         * writers when loading or saving this configuration.<a name="line.423"></a>
<FONT color="green">424</FONT>         *<a name="line.424"></a>
<FONT color="green">425</FONT>         * @return the {@code IOFactory}<a name="line.425"></a>
<FONT color="green">426</FONT>         * @since 1.7<a name="line.426"></a>
<FONT color="green">427</FONT>         */<a name="line.427"></a>
<FONT color="green">428</FONT>        public IOFactory getIOFactory()<a name="line.428"></a>
<FONT color="green">429</FONT>        {<a name="line.429"></a>
<FONT color="green">430</FONT>            return (ioFactory != null) ? ioFactory : DEFAULT_IO_FACTORY;<a name="line.430"></a>
<FONT color="green">431</FONT>        }<a name="line.431"></a>
<FONT color="green">432</FONT>    <a name="line.432"></a>
<FONT color="green">433</FONT>        /**<a name="line.433"></a>
<FONT color="green">434</FONT>         * Sets the {@code IOFactory} to be used for creating readers and<a name="line.434"></a>
<FONT color="green">435</FONT>         * writers when loading or saving this configuration. Using this method a<a name="line.435"></a>
<FONT color="green">436</FONT>         * client can customize the reader and writer classes used by the load and<a name="line.436"></a>
<FONT color="green">437</FONT>         * save operations. Note that this method must be called before invoking<a name="line.437"></a>
<FONT color="green">438</FONT>         * one of the {@code load()} and {@code save()} methods.<a name="line.438"></a>
<FONT color="green">439</FONT>         * Especially, if you want to use a custom {@code IOFactory} for<a name="line.439"></a>
<FONT color="green">440</FONT>         * changing the {@code PropertiesReader}, you cannot load the<a name="line.440"></a>
<FONT color="green">441</FONT>         * configuration data in the constructor.<a name="line.441"></a>
<FONT color="green">442</FONT>         *<a name="line.442"></a>
<FONT color="green">443</FONT>         * @param ioFactory the new {@code IOFactory} (must not be &lt;b&gt;null&lt;/b&gt;)<a name="line.443"></a>
<FONT color="green">444</FONT>         * @throws IllegalArgumentException if the {@code IOFactory} is<a name="line.444"></a>
<FONT color="green">445</FONT>         *         &lt;b&gt;null&lt;/b&gt;<a name="line.445"></a>
<FONT color="green">446</FONT>         * @since 1.7<a name="line.446"></a>
<FONT color="green">447</FONT>         */<a name="line.447"></a>
<FONT color="green">448</FONT>        public void setIOFactory(IOFactory ioFactory)<a name="line.448"></a>
<FONT color="green">449</FONT>        {<a name="line.449"></a>
<FONT color="green">450</FONT>            if (ioFactory == null)<a name="line.450"></a>
<FONT color="green">451</FONT>            {<a name="line.451"></a>
<FONT color="green">452</FONT>                throw new IllegalArgumentException("IOFactory must not be null!");<a name="line.452"></a>
<FONT color="green">453</FONT>            }<a name="line.453"></a>
<FONT color="green">454</FONT>    <a name="line.454"></a>
<FONT color="green">455</FONT>            this.ioFactory = ioFactory;<a name="line.455"></a>
<FONT color="green">456</FONT>        }<a name="line.456"></a>
<FONT color="green">457</FONT>    <a name="line.457"></a>
<FONT color="green">458</FONT>        /**<a name="line.458"></a>
<FONT color="green">459</FONT>         * Load the properties from the given reader.<a name="line.459"></a>
<FONT color="green">460</FONT>         * Note that the {@code clear()} method is not called, so<a name="line.460"></a>
<FONT color="green">461</FONT>         * the properties contained in the loaded file will be added to the<a name="line.461"></a>
<FONT color="green">462</FONT>         * actual set of properties.<a name="line.462"></a>
<FONT color="green">463</FONT>         *<a name="line.463"></a>
<FONT color="green">464</FONT>         * @param in An InputStream.<a name="line.464"></a>
<FONT color="green">465</FONT>         *<a name="line.465"></a>
<FONT color="green">466</FONT>         * @throws ConfigurationException if an error occurs<a name="line.466"></a>
<FONT color="green">467</FONT>         */<a name="line.467"></a>
<FONT color="green">468</FONT>        public synchronized void load(Reader in) throws ConfigurationException<a name="line.468"></a>
<FONT color="green">469</FONT>        {<a name="line.469"></a>
<FONT color="green">470</FONT>            boolean oldAutoSave = isAutoSave();<a name="line.470"></a>
<FONT color="green">471</FONT>            setAutoSave(false);<a name="line.471"></a>
<FONT color="green">472</FONT>    <a name="line.472"></a>
<FONT color="green">473</FONT>            try<a name="line.473"></a>
<FONT color="green">474</FONT>            {<a name="line.474"></a>
<FONT color="green">475</FONT>                getLayout().load(in);<a name="line.475"></a>
<FONT color="green">476</FONT>            }<a name="line.476"></a>
<FONT color="green">477</FONT>            finally<a name="line.477"></a>
<FONT color="green">478</FONT>            {<a name="line.478"></a>
<FONT color="green">479</FONT>                setAutoSave(oldAutoSave);<a name="line.479"></a>
<FONT color="green">480</FONT>            }<a name="line.480"></a>
<FONT color="green">481</FONT>        }<a name="line.481"></a>
<FONT color="green">482</FONT>    <a name="line.482"></a>
<FONT color="green">483</FONT>        /**<a name="line.483"></a>
<FONT color="green">484</FONT>         * Save the configuration to the specified stream.<a name="line.484"></a>
<FONT color="green">485</FONT>         *<a name="line.485"></a>
<FONT color="green">486</FONT>         * @param writer the output stream used to save the configuration<a name="line.486"></a>
<FONT color="green">487</FONT>         * @throws ConfigurationException if an error occurs<a name="line.487"></a>
<FONT color="green">488</FONT>         */<a name="line.488"></a>
<FONT color="green">489</FONT>        public void save(Writer writer) throws ConfigurationException<a name="line.489"></a>
<FONT color="green">490</FONT>        {<a name="line.490"></a>
<FONT color="green">491</FONT>            enterNoReload();<a name="line.491"></a>
<FONT color="green">492</FONT>            try<a name="line.492"></a>
<FONT color="green">493</FONT>            {<a name="line.493"></a>
<FONT color="green">494</FONT>                getLayout().save(writer);<a name="line.494"></a>
<FONT color="green">495</FONT>            }<a name="line.495"></a>
<FONT color="green">496</FONT>            finally<a name="line.496"></a>
<FONT color="green">497</FONT>            {<a name="line.497"></a>
<FONT color="green">498</FONT>                exitNoReload();<a name="line.498"></a>
<FONT color="green">499</FONT>            }<a name="line.499"></a>
<FONT color="green">500</FONT>        }<a name="line.500"></a>
<FONT color="green">501</FONT>    <a name="line.501"></a>
<FONT color="green">502</FONT>        /**<a name="line.502"></a>
<FONT color="green">503</FONT>         * Extend the setBasePath method to turn includes<a name="line.503"></a>
<FONT color="green">504</FONT>         * on and off based on the existence of a base path.<a name="line.504"></a>
<FONT color="green">505</FONT>         *<a name="line.505"></a>
<FONT color="green">506</FONT>         * @param basePath The new basePath to set.<a name="line.506"></a>
<FONT color="green">507</FONT>         */<a name="line.507"></a>
<FONT color="green">508</FONT>        @Override<a name="line.508"></a>
<FONT color="green">509</FONT>        public void setBasePath(String basePath)<a name="line.509"></a>
<FONT color="green">510</FONT>        {<a name="line.510"></a>
<FONT color="green">511</FONT>            super.setBasePath(basePath);<a name="line.511"></a>
<FONT color="green">512</FONT>            setIncludesAllowed(StringUtils.isNotEmpty(basePath));<a name="line.512"></a>
<FONT color="green">513</FONT>        }<a name="line.513"></a>
<FONT color="green">514</FONT>    <a name="line.514"></a>
<FONT color="green">515</FONT>        /**<a name="line.515"></a>
<FONT color="green">516</FONT>         * Creates a copy of this object.<a name="line.516"></a>
<FONT color="green">517</FONT>         *<a name="line.517"></a>
<FONT color="green">518</FONT>         * @return the copy<a name="line.518"></a>
<FONT color="green">519</FONT>         */<a name="line.519"></a>
<FONT color="green">520</FONT>        @Override<a name="line.520"></a>
<FONT color="green">521</FONT>        public Object clone()<a name="line.521"></a>
<FONT color="green">522</FONT>        {<a name="line.522"></a>
<FONT color="green">523</FONT>            PropertiesConfiguration copy = (PropertiesConfiguration) super.clone();<a name="line.523"></a>
<FONT color="green">524</FONT>            if (layout != null)<a name="line.524"></a>
<FONT color="green">525</FONT>            {<a name="line.525"></a>
<FONT color="green">526</FONT>                copy.setLayout(new PropertiesConfigurationLayout(copy, layout));<a name="line.526"></a>
<FONT color="green">527</FONT>            }<a name="line.527"></a>
<FONT color="green">528</FONT>            return copy;<a name="line.528"></a>
<FONT color="green">529</FONT>        }<a name="line.529"></a>
<FONT color="green">530</FONT>    <a name="line.530"></a>
<FONT color="green">531</FONT>        /**<a name="line.531"></a>
<FONT color="green">532</FONT>         * This method is invoked by the associated<a name="line.532"></a>
<FONT color="green">533</FONT>         * {@link PropertiesConfigurationLayout} object for each<a name="line.533"></a>
<FONT color="green">534</FONT>         * property definition detected in the parsed properties file. Its task is<a name="line.534"></a>
<FONT color="green">535</FONT>         * to check whether this is a special property definition (e.g. the<a name="line.535"></a>
<FONT color="green">536</FONT>         * {@code include} property). If not, the property must be added to<a name="line.536"></a>
<FONT color="green">537</FONT>         * this configuration. The return value indicates whether the property<a name="line.537"></a>
<FONT color="green">538</FONT>         * should be treated as a normal property. If it is &lt;b&gt;false&lt;/b&gt;, the<a name="line.538"></a>
<FONT color="green">539</FONT>         * layout object will ignore this property.<a name="line.539"></a>
<FONT color="green">540</FONT>         *<a name="line.540"></a>
<FONT color="green">541</FONT>         * @param key the property key<a name="line.541"></a>
<FONT color="green">542</FONT>         * @param value the property value<a name="line.542"></a>
<FONT color="green">543</FONT>         * @return a flag whether this is a normal property<a name="line.543"></a>
<FONT color="green">544</FONT>         * @throws ConfigurationException if an error occurs<a name="line.544"></a>
<FONT color="green">545</FONT>         * @since 1.3<a name="line.545"></a>
<FONT color="green">546</FONT>         */<a name="line.546"></a>
<FONT color="green">547</FONT>        boolean propertyLoaded(String key, String value)<a name="line.547"></a>
<FONT color="green">548</FONT>                throws ConfigurationException<a name="line.548"></a>
<FONT color="green">549</FONT>        {<a name="line.549"></a>
<FONT color="green">550</FONT>            boolean result;<a name="line.550"></a>
<FONT color="green">551</FONT>    <a name="line.551"></a>
<FONT color="green">552</FONT>            if (StringUtils.isNotEmpty(getInclude())<a name="line.552"></a>
<FONT color="green">553</FONT>                    &amp;&amp; key.equalsIgnoreCase(getInclude()))<a name="line.553"></a>
<FONT color="green">554</FONT>            {<a name="line.554"></a>
<FONT color="green">555</FONT>                if (getIncludesAllowed())<a name="line.555"></a>
<FONT color="green">556</FONT>                {<a name="line.556"></a>
<FONT color="green">557</FONT>                    String[] files;<a name="line.557"></a>
<FONT color="green">558</FONT>                    if (!isDelimiterParsingDisabled())<a name="line.558"></a>
<FONT color="green">559</FONT>                    {<a name="line.559"></a>
<FONT color="green">560</FONT>                        files = StringUtils.split(value, getListDelimiter());<a name="line.560"></a>
<FONT color="green">561</FONT>                    }<a name="line.561"></a>
<FONT color="green">562</FONT>                    else<a name="line.562"></a>
<FONT color="green">563</FONT>                    {<a name="line.563"></a>
<FONT color="green">564</FONT>                        files = new String[]{value};<a name="line.564"></a>
<FONT color="green">565</FONT>                    }<a name="line.565"></a>
<FONT color="green">566</FONT>                    for (String f : files)<a name="line.566"></a>
<FONT color="green">567</FONT>                    {<a name="line.567"></a>
<FONT color="green">568</FONT>                        loadIncludeFile(interpolate(f.trim()));<a name="line.568"></a>
<FONT color="green">569</FONT>                    }<a name="line.569"></a>
<FONT color="green">570</FONT>                }<a name="line.570"></a>
<FONT color="green">571</FONT>                result = false;<a name="line.571"></a>
<FONT color="green">572</FONT>            }<a name="line.572"></a>
<FONT color="green">573</FONT>    <a name="line.573"></a>
<FONT color="green">574</FONT>            else<a name="line.574"></a>
<FONT color="green">575</FONT>            {<a name="line.575"></a>
<FONT color="green">576</FONT>                addProperty(key, value);<a name="line.576"></a>
<FONT color="green">577</FONT>                result = true;<a name="line.577"></a>
<FONT color="green">578</FONT>            }<a name="line.578"></a>
<FONT color="green">579</FONT>    <a name="line.579"></a>
<FONT color="green">580</FONT>            return result;<a name="line.580"></a>
<FONT color="green">581</FONT>        }<a name="line.581"></a>
<FONT color="green">582</FONT>    <a name="line.582"></a>
<FONT color="green">583</FONT>        /**<a name="line.583"></a>
<FONT color="green">584</FONT>         * Tests whether a line is a comment, i.e. whether it starts with a comment<a name="line.584"></a>
<FONT color="green">585</FONT>         * character.<a name="line.585"></a>
<FONT color="green">586</FONT>         *<a name="line.586"></a>
<FONT color="green">587</FONT>         * @param line the line<a name="line.587"></a>
<FONT color="green">588</FONT>         * @return a flag if this is a comment line<a name="line.588"></a>
<FONT color="green">589</FONT>         * @since 1.3<a name="line.589"></a>
<FONT color="green">590</FONT>         */<a name="line.590"></a>
<FONT color="green">591</FONT>        static boolean isCommentLine(String line)<a name="line.591"></a>
<FONT color="green">592</FONT>        {<a name="line.592"></a>
<FONT color="green">593</FONT>            String s = line.trim();<a name="line.593"></a>
<FONT color="green">594</FONT>            // blanc lines are also treated as comment lines<a name="line.594"></a>
<FONT color="green">595</FONT>            return s.length() &lt; 1 || COMMENT_CHARS.indexOf(s.charAt(0)) &gt;= 0;<a name="line.595"></a>
<FONT color="green">596</FONT>        }<a name="line.596"></a>
<FONT color="green">597</FONT>    <a name="line.597"></a>
<FONT color="green">598</FONT>        /**<a name="line.598"></a>
<FONT color="green">599</FONT>         * Returns the number of trailing backslashes. This is sometimes needed for<a name="line.599"></a>
<FONT color="green">600</FONT>         * the correct handling of escape characters.<a name="line.600"></a>
<FONT color="green">601</FONT>         *<a name="line.601"></a>
<FONT color="green">602</FONT>         * @param line the string to investigate<a name="line.602"></a>
<FONT color="green">603</FONT>         * @return the number of trailing backslashes<a name="line.603"></a>
<FONT color="green">604</FONT>         */<a name="line.604"></a>
<FONT color="green">605</FONT>        private static int countTrailingBS(String line)<a name="line.605"></a>
<FONT color="green">606</FONT>        {<a name="line.606"></a>
<FONT color="green">607</FONT>            int bsCount = 0;<a name="line.607"></a>
<FONT color="green">608</FONT>            for (int idx = line.length() - 1; idx &gt;= 0 &amp;&amp; line.charAt(idx) == '\\'; idx--)<a name="line.608"></a>
<FONT color="green">609</FONT>            {<a name="line.609"></a>
<FONT color="green">610</FONT>                bsCount++;<a name="line.610"></a>
<FONT color="green">611</FONT>            }<a name="line.611"></a>
<FONT color="green">612</FONT>    <a name="line.612"></a>
<FONT color="green">613</FONT>            return bsCount;<a name="line.613"></a>
<FONT color="green">614</FONT>        }<a name="line.614"></a>
<FONT color="green">615</FONT>    <a name="line.615"></a>
<FONT color="green">616</FONT>        /**<a name="line.616"></a>
<FONT color="green">617</FONT>         * This class is used to read properties lines. These lines do<a name="line.617"></a>
<FONT color="green">618</FONT>         * not terminate with new-line chars but rather when there is no<a name="line.618"></a>
<FONT color="green">619</FONT>         * backslash sign a the end of the line.  This is used to<a name="line.619"></a>
<FONT color="green">620</FONT>         * concatenate multiple lines for readability.<a name="line.620"></a>
<FONT color="green">621</FONT>         */<a name="line.621"></a>
<FONT color="green">622</FONT>        public static class PropertiesReader extends LineNumberReader<a name="line.622"></a>
<FONT color="green">623</FONT>        {<a name="line.623"></a>
<FONT color="green">624</FONT>            /** The regular expression to parse the key and the value of a property. */<a name="line.624"></a>
<FONT color="green">625</FONT>            private static final Pattern PROPERTY_PATTERN = Pattern<a name="line.625"></a>
<FONT color="green">626</FONT>                    .compile("(([\\S&amp;&amp;[^\\\\" + new String(SEPARATORS)<a name="line.626"></a>
<FONT color="green">627</FONT>                            + "]]|\\\\.)*)(\\s*(\\s+|[" + new String(SEPARATORS)<a name="line.627"></a>
<FONT color="green">628</FONT>                            + "])\\s*)(.*)");<a name="line.628"></a>
<FONT color="green">629</FONT>    <a name="line.629"></a>
<FONT color="green">630</FONT>            /** Constant for the index of the group for the key. */<a name="line.630"></a>
<FONT color="green">631</FONT>            private static final int IDX_KEY = 1;<a name="line.631"></a>
<FONT color="green">632</FONT>    <a name="line.632"></a>
<FONT color="green">633</FONT>            /** Constant for the index of the group for the value. */<a name="line.633"></a>
<FONT color="green">634</FONT>            private static final int IDX_VALUE = 5;<a name="line.634"></a>
<FONT color="green">635</FONT>    <a name="line.635"></a>
<FONT color="green">636</FONT>            /** Constant for the index of the group for the separator. */<a name="line.636"></a>
<FONT color="green">637</FONT>            private static final int IDX_SEPARATOR = 3;<a name="line.637"></a>
<FONT color="green">638</FONT>    <a name="line.638"></a>
<FONT color="green">639</FONT>            /** Stores the comment lines for the currently processed property.*/<a name="line.639"></a>
<FONT color="green">640</FONT>            private List&lt;String&gt; commentLines;<a name="line.640"></a>
<FONT color="green">641</FONT>    <a name="line.641"></a>
<FONT color="green">642</FONT>            /** Stores the name of the last read property.*/<a name="line.642"></a>
<FONT color="green">643</FONT>            private String propertyName;<a name="line.643"></a>
<FONT color="green">644</FONT>    <a name="line.644"></a>
<FONT color="green">645</FONT>            /** Stores the value of the last read property.*/<a name="line.645"></a>
<FONT color="green">646</FONT>            private String propertyValue;<a name="line.646"></a>
<FONT color="green">647</FONT>    <a name="line.647"></a>
<FONT color="green">648</FONT>            /** Stores the property separator of the last read property.*/<a name="line.648"></a>
<FONT color="green">649</FONT>            private String propertySeparator = DEFAULT_SEPARATOR;<a name="line.649"></a>
<FONT color="green">650</FONT>    <a name="line.650"></a>
<FONT color="green">651</FONT>            /** Stores the list delimiter character.*/<a name="line.651"></a>
<FONT color="green">652</FONT>            private char delimiter;<a name="line.652"></a>
<FONT color="green">653</FONT>    <a name="line.653"></a>
<FONT color="green">654</FONT>            /**<a name="line.654"></a>
<FONT color="green">655</FONT>             * Constructor.<a name="line.655"></a>
<FONT color="green">656</FONT>             *<a name="line.656"></a>
<FONT color="green">657</FONT>             * @param reader A Reader.<a name="line.657"></a>
<FONT color="green">658</FONT>             */<a name="line.658"></a>
<FONT color="green">659</FONT>            public PropertiesReader(Reader reader)<a name="line.659"></a>
<FONT color="green">660</FONT>            {<a name="line.660"></a>
<FONT color="green">661</FONT>                this(reader, AbstractConfiguration.getDefaultListDelimiter());<a name="line.661"></a>
<FONT color="green">662</FONT>            }<a name="line.662"></a>
<FONT color="green">663</FONT>    <a name="line.663"></a>
<FONT color="green">664</FONT>            /**<a name="line.664"></a>
<FONT color="green">665</FONT>             * Creates a new instance of {@code PropertiesReader} and sets<a name="line.665"></a>
<FONT color="green">666</FONT>             * the underlying reader and the list delimiter.<a name="line.666"></a>
<FONT color="green">667</FONT>             *<a name="line.667"></a>
<FONT color="green">668</FONT>             * @param reader the reader<a name="line.668"></a>
<FONT color="green">669</FONT>             * @param listDelimiter the list delimiter character<a name="line.669"></a>
<FONT color="green">670</FONT>             * @since 1.3<a name="line.670"></a>
<FONT color="green">671</FONT>             */<a name="line.671"></a>
<FONT color="green">672</FONT>            public PropertiesReader(Reader reader, char listDelimiter)<a name="line.672"></a>
<FONT color="green">673</FONT>            {<a name="line.673"></a>
<FONT color="green">674</FONT>                super(reader);<a name="line.674"></a>
<FONT color="green">675</FONT>                commentLines = new ArrayList&lt;String&gt;();<a name="line.675"></a>
<FONT color="green">676</FONT>                delimiter = listDelimiter;<a name="line.676"></a>
<FONT color="green">677</FONT>            }<a name="line.677"></a>
<FONT color="green">678</FONT>    <a name="line.678"></a>
<FONT color="green">679</FONT>            /**<a name="line.679"></a>
<FONT color="green">680</FONT>             * Reads a property line. Returns null if Stream is<a name="line.680"></a>
<FONT color="green">681</FONT>             * at EOF. Concatenates lines ending with "\".<a name="line.681"></a>
<FONT color="green">682</FONT>             * Skips lines beginning with "#" or "!" and empty lines.<a name="line.682"></a>
<FONT color="green">683</FONT>             * The return value is a property definition (&lt;code&gt;&amp;lt;name&amp;gt;&lt;/code&gt;<a name="line.683"></a>
<FONT color="green">684</FONT>             * = &lt;code&gt;&amp;lt;value&amp;gt;&lt;/code&gt;)<a name="line.684"></a>
<FONT color="green">685</FONT>             *<a name="line.685"></a>
<FONT color="green">686</FONT>             * @return A string containing a property value or null<a name="line.686"></a>
<FONT color="green">687</FONT>             *<a name="line.687"></a>
<FONT color="green">688</FONT>             * @throws IOException in case of an I/O error<a name="line.688"></a>
<FONT color="green">689</FONT>             */<a name="line.689"></a>
<FONT color="green">690</FONT>            public String readProperty() throws IOException<a name="line.690"></a>
<FONT color="green">691</FONT>            {<a name="line.691"></a>
<FONT color="green">692</FONT>                commentLines.clear();<a name="line.692"></a>
<FONT color="green">693</FONT>                StringBuilder buffer = new StringBuilder();<a name="line.693"></a>
<FONT color="green">694</FONT>    <a name="line.694"></a>
<FONT color="green">695</FONT>                while (true)<a name="line.695"></a>
<FONT color="green">696</FONT>                {<a name="line.696"></a>
<FONT color="green">697</FONT>                    String line = readLine();<a name="line.697"></a>
<FONT color="green">698</FONT>                    if (line == null)<a name="line.698"></a>
<FONT color="green">699</FONT>                    {<a name="line.699"></a>
<FONT color="green">700</FONT>                        // EOF<a name="line.700"></a>
<FONT color="green">701</FONT>                        return null;<a name="line.701"></a>
<FONT color="green">702</FONT>                    }<a name="line.702"></a>
<FONT color="green">703</FONT>    <a name="line.703"></a>
<FONT color="green">704</FONT>                    if (isCommentLine(line))<a name="line.704"></a>
<FONT color="green">705</FONT>                    {<a name="line.705"></a>
<FONT color="green">706</FONT>                        commentLines.add(line);<a name="line.706"></a>
<FONT color="green">707</FONT>                        continue;<a name="line.707"></a>
<FONT color="green">708</FONT>                    }<a name="line.708"></a>
<FONT color="green">709</FONT>    <a name="line.709"></a>
<FONT color="green">710</FONT>                    line = line.trim();<a name="line.710"></a>
<FONT color="green">711</FONT>    <a name="line.711"></a>
<FONT color="green">712</FONT>                    if (checkCombineLines(line))<a name="line.712"></a>
<FONT color="green">713</FONT>                    {<a name="line.713"></a>
<FONT color="green">714</FONT>                        line = line.substring(0, line.length() - 1);<a name="line.714"></a>
<FONT color="green">715</FONT>                        buffer.append(line);<a name="line.715"></a>
<FONT color="green">716</FONT>                    }<a name="line.716"></a>
<FONT color="green">717</FONT>                    else<a name="line.717"></a>
<FONT color="green">718</FONT>                    {<a name="line.718"></a>
<FONT color="green">719</FONT>                        buffer.append(line);<a name="line.719"></a>
<FONT color="green">720</FONT>                        break;<a name="line.720"></a>
<FONT color="green">721</FONT>                    }<a name="line.721"></a>
<FONT color="green">722</FONT>                }<a name="line.722"></a>
<FONT color="green">723</FONT>                return buffer.toString();<a name="line.723"></a>
<FONT color="green">724</FONT>            }<a name="line.724"></a>
<FONT color="green">725</FONT>    <a name="line.725"></a>
<FONT color="green">726</FONT>            /**<a name="line.726"></a>
<FONT color="green">727</FONT>             * Parses the next property from the input stream and stores the found<a name="line.727"></a>
<FONT color="green">728</FONT>             * name and value in internal fields. These fields can be obtained using<a name="line.728"></a>
<FONT color="green">729</FONT>             * the provided getter methods. The return value indicates whether EOF<a name="line.729"></a>
<FONT color="green">730</FONT>             * was reached (&lt;b&gt;false&lt;/b&gt;) or whether further properties are<a name="line.730"></a>
<FONT color="green">731</FONT>             * available (&lt;b&gt;true&lt;/b&gt;).<a name="line.731"></a>
<FONT color="green">732</FONT>             *<a name="line.732"></a>
<FONT color="green">733</FONT>             * @return a flag if further properties are available<a name="line.733"></a>
<FONT color="green">734</FONT>             * @throws IOException if an error occurs<a name="line.734"></a>
<FONT color="green">735</FONT>             * @since 1.3<a name="line.735"></a>
<FONT color="green">736</FONT>             */<a name="line.736"></a>
<FONT color="green">737</FONT>            public boolean nextProperty() throws IOException<a name="line.737"></a>
<FONT color="green">738</FONT>            {<a name="line.738"></a>
<FONT color="green">739</FONT>                String line = readProperty();<a name="line.739"></a>
<FONT color="green">740</FONT>    <a name="line.740"></a>
<FONT color="green">741</FONT>                if (line == null)<a name="line.741"></a>
<FONT color="green">742</FONT>                {<a name="line.742"></a>
<FONT color="green">743</FONT>                    return false; // EOF<a name="line.743"></a>
<FONT color="green">744</FONT>                }<a name="line.744"></a>
<FONT color="green">745</FONT>    <a name="line.745"></a>
<FONT color="green">746</FONT>                // parse the line<a name="line.746"></a>
<FONT color="green">747</FONT>                parseProperty(line);<a name="line.747"></a>
<FONT color="green">748</FONT>                return true;<a name="line.748"></a>
<FONT color="green">749</FONT>            }<a name="line.749"></a>
<FONT color="green">750</FONT>    <a name="line.750"></a>
<FONT color="green">751</FONT>            /**<a name="line.751"></a>
<FONT color="green">752</FONT>             * Returns the comment lines that have been read for the last property.<a name="line.752"></a>
<FONT color="green">753</FONT>             *<a name="line.753"></a>
<FONT color="green">754</FONT>             * @return the comment lines for the last property returned by<a name="line.754"></a>
<FONT color="green">755</FONT>             * {@code readProperty()}<a name="line.755"></a>
<FONT color="green">756</FONT>             * @since 1.3<a name="line.756"></a>
<FONT color="green">757</FONT>             */<a name="line.757"></a>
<FONT color="green">758</FONT>            public List&lt;String&gt; getCommentLines()<a name="line.758"></a>
<FONT color="green">759</FONT>            {<a name="line.759"></a>
<FONT color="green">760</FONT>                return commentLines;<a name="line.760"></a>
<FONT color="green">761</FONT>            }<a name="line.761"></a>
<FONT color="green">762</FONT>    <a name="line.762"></a>
<FONT color="green">763</FONT>            /**<a name="line.763"></a>
<FONT color="green">764</FONT>             * Returns the name of the last read property. This method can be called<a name="line.764"></a>
<FONT color="green">765</FONT>             * after {@link #nextProperty()} was invoked and its<a name="line.765"></a>
<FONT color="green">766</FONT>             * return value was &lt;b&gt;true&lt;/b&gt;.<a name="line.766"></a>
<FONT color="green">767</FONT>             *<a name="line.767"></a>
<FONT color="green">768</FONT>             * @return the name of the last read property<a name="line.768"></a>
<FONT color="green">769</FONT>             * @since 1.3<a name="line.769"></a>
<FONT color="green">770</FONT>             */<a name="line.770"></a>
<FONT color="green">771</FONT>            public String getPropertyName()<a name="line.771"></a>
<FONT color="green">772</FONT>            {<a name="line.772"></a>
<FONT color="green">773</FONT>                return propertyName;<a name="line.773"></a>
<FONT color="green">774</FONT>            }<a name="line.774"></a>
<FONT color="green">775</FONT>    <a name="line.775"></a>
<FONT color="green">776</FONT>            /**<a name="line.776"></a>
<FONT color="green">777</FONT>             * Returns the value of the last read property. This method can be<a name="line.777"></a>
<FONT color="green">778</FONT>             * called after {@link #nextProperty()} was invoked and<a name="line.778"></a>
<FONT color="green">779</FONT>             * its return value was &lt;b&gt;true&lt;/b&gt;.<a name="line.779"></a>
<FONT color="green">780</FONT>             *<a name="line.780"></a>
<FONT color="green">781</FONT>             * @return the value of the last read property<a name="line.781"></a>
<FONT color="green">782</FONT>             * @since 1.3<a name="line.782"></a>
<FONT color="green">783</FONT>             */<a name="line.783"></a>
<FONT color="green">784</FONT>            public String getPropertyValue()<a name="line.784"></a>
<FONT color="green">785</FONT>            {<a name="line.785"></a>
<FONT color="green">786</FONT>                return propertyValue;<a name="line.786"></a>
<FONT color="green">787</FONT>            }<a name="line.787"></a>
<FONT color="green">788</FONT>    <a name="line.788"></a>
<FONT color="green">789</FONT>            /**<a name="line.789"></a>
<FONT color="green">790</FONT>             * Returns the separator that was used for the last read property. The<a name="line.790"></a>
<FONT color="green">791</FONT>             * separator can be stored so that it can later be restored when saving<a name="line.791"></a>
<FONT color="green">792</FONT>             * the configuration.<a name="line.792"></a>
<FONT color="green">793</FONT>             *<a name="line.793"></a>
<FONT color="green">794</FONT>             * @return the separator for the last read property<a name="line.794"></a>
<FONT color="green">795</FONT>             * @since 1.7<a name="line.795"></a>
<FONT color="green">796</FONT>             */<a name="line.796"></a>
<FONT color="green">797</FONT>            public String getPropertySeparator()<a name="line.797"></a>
<FONT color="green">798</FONT>            {<a name="line.798"></a>
<FONT color="green">799</FONT>                return propertySeparator;<a name="line.799"></a>
<FONT color="green">800</FONT>            }<a name="line.800"></a>
<FONT color="green">801</FONT>    <a name="line.801"></a>
<FONT color="green">802</FONT>            /**<a name="line.802"></a>
<FONT color="green">803</FONT>             * Parses a line read from the properties file. This method is called<a name="line.803"></a>
<FONT color="green">804</FONT>             * for each non-comment line read from the source file. Its task is to<a name="line.804"></a>
<FONT color="green">805</FONT>             * split the passed in line into the property key and its value. The<a name="line.805"></a>
<FONT color="green">806</FONT>             * results of the parse operation can be stored by calling the<a name="line.806"></a>
<FONT color="green">807</FONT>             * {@code initPropertyXXX()} methods.<a name="line.807"></a>
<FONT color="green">808</FONT>             *<a name="line.808"></a>
<FONT color="green">809</FONT>             * @param line the line read from the properties file<a name="line.809"></a>
<FONT color="green">810</FONT>             * @since 1.7<a name="line.810"></a>
<FONT color="green">811</FONT>             */<a name="line.811"></a>
<FONT color="green">812</FONT>            protected void parseProperty(String line)<a name="line.812"></a>
<FONT color="green">813</FONT>            {<a name="line.813"></a>
<FONT color="green">814</FONT>                String[] property = doParseProperty(line);<a name="line.814"></a>
<FONT color="green">815</FONT>                initPropertyName(property[0]);<a name="line.815"></a>
<FONT color="green">816</FONT>                initPropertyValue(property[1]);<a name="line.816"></a>
<FONT color="green">817</FONT>                initPropertySeparator(property[2]);<a name="line.817"></a>
<FONT color="green">818</FONT>            }<a name="line.818"></a>
<FONT color="green">819</FONT>    <a name="line.819"></a>
<FONT color="green">820</FONT>            /**<a name="line.820"></a>
<FONT color="green">821</FONT>             * Sets the name of the current property. This method can be called by<a name="line.821"></a>
<FONT color="green">822</FONT>             * {@code parseProperty()} for storing the results of the parse<a name="line.822"></a>
<FONT color="green">823</FONT>             * operation. It also ensures that the property key is correctly<a name="line.823"></a>
<FONT color="green">824</FONT>             * escaped.<a name="line.824"></a>
<FONT color="green">825</FONT>             *<a name="line.825"></a>
<FONT color="green">826</FONT>             * @param name the name of the current property<a name="line.826"></a>
<FONT color="green">827</FONT>             * @since 1.7<a name="line.827"></a>
<FONT color="green">828</FONT>             */<a name="line.828"></a>
<FONT color="green">829</FONT>            protected void initPropertyName(String name)<a name="line.829"></a>
<FONT color="green">830</FONT>            {<a name="line.830"></a>
<FONT color="green">831</FONT>                propertyName = StringEscapeUtils.unescapeJava(name);<a name="line.831"></a>
<FONT color="green">832</FONT>            }<a name="line.832"></a>
<FONT color="green">833</FONT>    <a name="line.833"></a>
<FONT color="green">834</FONT>            /**<a name="line.834"></a>
<FONT color="green">835</FONT>             * Sets the value of the current property. This method can be called by<a name="line.835"></a>
<FONT color="green">836</FONT>             * {@code parseProperty()} for storing the results of the parse<a name="line.836"></a>
<FONT color="green">837</FONT>             * operation. It also ensures that the property value is correctly<a name="line.837"></a>
<FONT color="green">838</FONT>             * escaped.<a name="line.838"></a>
<FONT color="green">839</FONT>             *<a name="line.839"></a>
<FONT color="green">840</FONT>             * @param value the value of the current property<a name="line.840"></a>
<FONT color="green">841</FONT>             * @since 1.7<a name="line.841"></a>
<FONT color="green">842</FONT>             */<a name="line.842"></a>
<FONT color="green">843</FONT>            protected void initPropertyValue(String value)<a name="line.843"></a>
<FONT color="green">844</FONT>            {<a name="line.844"></a>
<FONT color="green">845</FONT>                propertyValue = unescapeJava(value, delimiter);<a name="line.845"></a>
<FONT color="green">846</FONT>            }<a name="line.846"></a>
<FONT color="green">847</FONT>    <a name="line.847"></a>
<FONT color="green">848</FONT>            /**<a name="line.848"></a>
<FONT color="green">849</FONT>             * Sets the separator of the current property. This method can be called<a name="line.849"></a>
<FONT color="green">850</FONT>             * by {@code parseProperty()}. It allows the associated layout<a name="line.850"></a>
<FONT color="green">851</FONT>             * object to keep track of the property separators. When saving the<a name="line.851"></a>
<FONT color="green">852</FONT>             * configuration the separators can be restored.<a name="line.852"></a>
<FONT color="green">853</FONT>             *<a name="line.853"></a>
<FONT color="green">854</FONT>             * @param value the separator used for the current property<a name="line.854"></a>
<FONT color="green">855</FONT>             * @since 1.7<a name="line.855"></a>
<FONT color="green">856</FONT>             */<a name="line.856"></a>
<FONT color="green">857</FONT>            protected void initPropertySeparator(String value)<a name="line.857"></a>
<FONT color="green">858</FONT>            {<a name="line.858"></a>
<FONT color="green">859</FONT>                propertySeparator = value;<a name="line.859"></a>
<FONT color="green">860</FONT>            }<a name="line.860"></a>
<FONT color="green">861</FONT>    <a name="line.861"></a>
<FONT color="green">862</FONT>            /**<a name="line.862"></a>
<FONT color="green">863</FONT>             * Checks if the passed in line should be combined with the following.<a name="line.863"></a>
<FONT color="green">864</FONT>             * This is true, if the line ends with an odd number of backslashes.<a name="line.864"></a>
<FONT color="green">865</FONT>             *<a name="line.865"></a>
<FONT color="green">866</FONT>             * @param line the line<a name="line.866"></a>
<FONT color="green">867</FONT>             * @return a flag if the lines should be combined<a name="line.867"></a>
<FONT color="green">868</FONT>             */<a name="line.868"></a>
<FONT color="green">869</FONT>            private static boolean checkCombineLines(String line)<a name="line.869"></a>
<FONT color="green">870</FONT>            {<a name="line.870"></a>
<FONT color="green">871</FONT>                return countTrailingBS(line) % 2 != 0;<a name="line.871"></a>
<FONT color="green">872</FONT>            }<a name="line.872"></a>
<FONT color="green">873</FONT>    <a name="line.873"></a>
<FONT color="green">874</FONT>            /**<a name="line.874"></a>
<FONT color="green">875</FONT>             * Parse a property line and return the key, the value, and the separator in an array.<a name="line.875"></a>
<FONT color="green">876</FONT>             *<a name="line.876"></a>
<FONT color="green">877</FONT>             * @param line the line to parse<a name="line.877"></a>
<FONT color="green">878</FONT>             * @return an array with the property's key, value, and separator<a name="line.878"></a>
<FONT color="green">879</FONT>             */<a name="line.879"></a>
<FONT color="green">880</FONT>            private static String[] doParseProperty(String line)<a name="line.880"></a>
<FONT color="green">881</FONT>            {<a name="line.881"></a>
<FONT color="green">882</FONT>                Matcher matcher = PROPERTY_PATTERN.matcher(line);<a name="line.882"></a>
<FONT color="green">883</FONT>    <a name="line.883"></a>
<FONT color="green">884</FONT>                String[] result = {"", "", ""};<a name="line.884"></a>
<FONT color="green">885</FONT>    <a name="line.885"></a>
<FONT color="green">886</FONT>                if (matcher.matches())<a name="line.886"></a>
<FONT color="green">887</FONT>                {<a name="line.887"></a>
<FONT color="green">888</FONT>                    result[0] = matcher.group(IDX_KEY).trim();<a name="line.888"></a>
<FONT color="green">889</FONT>                    result[1] = matcher.group(IDX_VALUE).trim();<a name="line.889"></a>
<FONT color="green">890</FONT>                    result[2] = matcher.group(IDX_SEPARATOR);<a name="line.890"></a>
<FONT color="green">891</FONT>                }<a name="line.891"></a>
<FONT color="green">892</FONT>    <a name="line.892"></a>
<FONT color="green">893</FONT>                return result;<a name="line.893"></a>
<FONT color="green">894</FONT>            }<a name="line.894"></a>
<FONT color="green">895</FONT>        } // class PropertiesReader<a name="line.895"></a>
<FONT color="green">896</FONT>    <a name="line.896"></a>
<FONT color="green">897</FONT>        /**<a name="line.897"></a>
<FONT color="green">898</FONT>         * This class is used to write properties lines. The most important method<a name="line.898"></a>
<FONT color="green">899</FONT>         * is {@code writeProperty(String, Object, boolean)}, which is called<a name="line.899"></a>
<FONT color="green">900</FONT>         * during a save operation for each property found in the configuration.<a name="line.900"></a>
<FONT color="green">901</FONT>         */<a name="line.901"></a>
<FONT color="green">902</FONT>        public static class PropertiesWriter extends FilterWriter<a name="line.902"></a>
<FONT color="green">903</FONT>        {<a name="line.903"></a>
<FONT color="green">904</FONT>            /** Constant for the initial size when creating a string buffer. */<a name="line.904"></a>
<FONT color="green">905</FONT>            private static final int BUF_SIZE = 8;<a name="line.905"></a>
<FONT color="green">906</FONT>    <a name="line.906"></a>
<FONT color="green">907</FONT>            /** The delimiter for multi-valued properties.*/<a name="line.907"></a>
<FONT color="green">908</FONT>            private char delimiter;<a name="line.908"></a>
<FONT color="green">909</FONT>    <a name="line.909"></a>
<FONT color="green">910</FONT>            /** The separator to be used for the current property. */<a name="line.910"></a>
<FONT color="green">911</FONT>            private String currentSeparator;<a name="line.911"></a>
<FONT color="green">912</FONT>    <a name="line.912"></a>
<FONT color="green">913</FONT>            /** The global separator. If set, it overrides the current separator.*/<a name="line.913"></a>
<FONT color="green">914</FONT>            private String globalSeparator;<a name="line.914"></a>
<FONT color="green">915</FONT>    <a name="line.915"></a>
<FONT color="green">916</FONT>            /** The line separator.*/<a name="line.916"></a>
<FONT color="green">917</FONT>            private String lineSeparator;<a name="line.917"></a>
<FONT color="green">918</FONT>    <a name="line.918"></a>
<FONT color="green">919</FONT>            /**<a name="line.919"></a>
<FONT color="green">920</FONT>             * Constructor.<a name="line.920"></a>
<FONT color="green">921</FONT>             *<a name="line.921"></a>
<FONT color="green">922</FONT>             * @param writer a Writer object providing the underlying stream<a name="line.922"></a>
<FONT color="green">923</FONT>             * @param delimiter the delimiter character for multi-valued properties<a name="line.923"></a>
<FONT color="green">924</FONT>             */<a name="line.924"></a>
<FONT color="green">925</FONT>            public PropertiesWriter(Writer writer, char delimiter)<a name="line.925"></a>
<FONT color="green">926</FONT>            {<a name="line.926"></a>
<FONT color="green">927</FONT>                super(writer);<a name="line.927"></a>
<FONT color="green">928</FONT>                this.delimiter = delimiter;<a name="line.928"></a>
<FONT color="green">929</FONT>            }<a name="line.929"></a>
<FONT color="green">930</FONT>    <a name="line.930"></a>
<FONT color="green">931</FONT>            /**<a name="line.931"></a>
<FONT color="green">932</FONT>             * Returns the current property separator.<a name="line.932"></a>
<FONT color="green">933</FONT>             *<a name="line.933"></a>
<FONT color="green">934</FONT>             * @return the current property separator<a name="line.934"></a>
<FONT color="green">935</FONT>             * @since 1.7<a name="line.935"></a>
<FONT color="green">936</FONT>             */<a name="line.936"></a>
<FONT color="green">937</FONT>            public String getCurrentSeparator()<a name="line.937"></a>
<FONT color="green">938</FONT>            {<a name="line.938"></a>
<FONT color="green">939</FONT>                return currentSeparator;<a name="line.939"></a>
<FONT color="green">940</FONT>            }<a name="line.940"></a>
<FONT color="green">941</FONT>    <a name="line.941"></a>
<FONT color="green">942</FONT>            /**<a name="line.942"></a>
<FONT color="green">943</FONT>             * Sets the current property separator. This separator is used when<a name="line.943"></a>
<FONT color="green">944</FONT>             * writing the next property.<a name="line.944"></a>
<FONT color="green">945</FONT>             *<a name="line.945"></a>
<FONT color="green">946</FONT>             * @param currentSeparator the current property separator<a name="line.946"></a>
<FONT color="green">947</FONT>             * @since 1.7<a name="line.947"></a>
<FONT color="green">948</FONT>             */<a name="line.948"></a>
<FONT color="green">949</FONT>            public void setCurrentSeparator(String currentSeparator)<a name="line.949"></a>
<FONT color="green">950</FONT>            {<a name="line.950"></a>
<FONT color="green">951</FONT>                this.currentSeparator = currentSeparator;<a name="line.951"></a>
<FONT color="green">952</FONT>            }<a name="line.952"></a>
<FONT color="green">953</FONT>    <a name="line.953"></a>
<FONT color="green">954</FONT>            /**<a name="line.954"></a>
<FONT color="green">955</FONT>             * Returns the global property separator.<a name="line.955"></a>
<FONT color="green">956</FONT>             *<a name="line.956"></a>
<FONT color="green">957</FONT>             * @return the global property separator<a name="line.957"></a>
<FONT color="green">958</FONT>             * @since 1.7<a name="line.958"></a>
<FONT color="green">959</FONT>             */<a name="line.959"></a>
<FONT color="green">960</FONT>            public String getGlobalSeparator()<a name="line.960"></a>
<FONT color="green">961</FONT>            {<a name="line.961"></a>
<FONT color="green">962</FONT>                return globalSeparator;<a name="line.962"></a>
<FONT color="green">963</FONT>            }<a name="line.963"></a>
<FONT color="green">964</FONT>    <a name="line.964"></a>
<FONT color="green">965</FONT>            /**<a name="line.965"></a>
<FONT color="green">966</FONT>             * Sets the global property separator. This separator corresponds to the<a name="line.966"></a>
<FONT color="green">967</FONT>             * {@code globalSeparator} property of<a name="line.967"></a>
<FONT color="green">968</FONT>             * {@link PropertiesConfigurationLayout}. It defines the separator to be<a name="line.968"></a>
<FONT color="green">969</FONT>             * used for all properties. If it is undefined, the current separator is<a name="line.969"></a>
<FONT color="green">970</FONT>             * used.<a name="line.970"></a>
<FONT color="green">971</FONT>             *<a name="line.971"></a>
<FONT color="green">972</FONT>             * @param globalSeparator the global property separator<a name="line.972"></a>
<FONT color="green">973</FONT>             * @since 1.7<a name="line.973"></a>
<FONT color="green">974</FONT>             */<a name="line.974"></a>
<FONT color="green">975</FONT>            public void setGlobalSeparator(String globalSeparator)<a name="line.975"></a>
<FONT color="green">976</FONT>            {<a name="line.976"></a>
<FONT color="green">977</FONT>                this.globalSeparator = globalSeparator;<a name="line.977"></a>
<FONT color="green">978</FONT>            }<a name="line.978"></a>
<FONT color="green">979</FONT>    <a name="line.979"></a>
<FONT color="green">980</FONT>            /**<a name="line.980"></a>
<FONT color="green">981</FONT>             * Returns the line separator.<a name="line.981"></a>
<FONT color="green">982</FONT>             *<a name="line.982"></a>
<FONT color="green">983</FONT>             * @return the line separator<a name="line.983"></a>
<FONT color="green">984</FONT>             * @since 1.7<a name="line.984"></a>
<FONT color="green">985</FONT>             */<a name="line.985"></a>
<FONT color="green">986</FONT>            public String getLineSeparator()<a name="line.986"></a>
<FONT color="green">987</FONT>            {<a name="line.987"></a>
<FONT color="green">988</FONT>                return (lineSeparator != null) ? lineSeparator : LINE_SEPARATOR;<a name="line.988"></a>
<FONT color="green">989</FONT>            }<a name="line.989"></a>
<FONT color="green">990</FONT>    <a name="line.990"></a>
<FONT color="green">991</FONT>            /**<a name="line.991"></a>
<FONT color="green">992</FONT>             * Sets the line separator. Each line written by this writer is<a name="line.992"></a>
<FONT color="green">993</FONT>             * terminated with this separator. If not set, the platform-specific<a name="line.993"></a>
<FONT color="green">994</FONT>             * line separator is used.<a name="line.994"></a>
<FONT color="green">995</FONT>             *<a name="line.995"></a>
<FONT color="green">996</FONT>             * @param lineSeparator the line separator to be used<a name="line.996"></a>
<FONT color="green">997</FONT>             * @since 1.7<a name="line.997"></a>
<FONT color="green">998</FONT>             */<a name="line.998"></a>
<FONT color="green">999</FONT>            public void setLineSeparator(String lineSeparator)<a name="line.999"></a>
<FONT color="green">1000</FONT>            {<a name="line.1000"></a>
<FONT color="green">1001</FONT>                this.lineSeparator = lineSeparator;<a name="line.1001"></a>
<FONT color="green">1002</FONT>            }<a name="line.1002"></a>
<FONT color="green">1003</FONT>    <a name="line.1003"></a>
<FONT color="green">1004</FONT>            /**<a name="line.1004"></a>
<FONT color="green">1005</FONT>             * Write a property.<a name="line.1005"></a>
<FONT color="green">1006</FONT>             *<a name="line.1006"></a>
<FONT color="green">1007</FONT>             * @param key the key of the property<a name="line.1007"></a>
<FONT color="green">1008</FONT>             * @param value the value of the property<a name="line.1008"></a>
<FONT color="green">1009</FONT>             *<a name="line.1009"></a>
<FONT color="green">1010</FONT>             * @throws IOException if an I/O error occurs<a name="line.1010"></a>
<FONT color="green">1011</FONT>             */<a name="line.1011"></a>
<FONT color="green">1012</FONT>            public void writeProperty(String key, Object value) throws IOException<a name="line.1012"></a>
<FONT color="green">1013</FONT>            {<a name="line.1013"></a>
<FONT color="green">1014</FONT>                writeProperty(key, value, false);<a name="line.1014"></a>
<FONT color="green">1015</FONT>            }<a name="line.1015"></a>
<FONT color="green">1016</FONT>    <a name="line.1016"></a>
<FONT color="green">1017</FONT>            /**<a name="line.1017"></a>
<FONT color="green">1018</FONT>             * Write a property.<a name="line.1018"></a>
<FONT color="green">1019</FONT>             *<a name="line.1019"></a>
<FONT color="green">1020</FONT>             * @param key The key of the property<a name="line.1020"></a>
<FONT color="green">1021</FONT>             * @param values The array of values of the property<a name="line.1021"></a>
<FONT color="green">1022</FONT>             *<a name="line.1022"></a>
<FONT color="green">1023</FONT>             * @throws IOException if an I/O error occurs<a name="line.1023"></a>
<FONT color="green">1024</FONT>             */<a name="line.1024"></a>
<FONT color="green">1025</FONT>            public void writeProperty(String key, List&lt;?&gt; values) throws IOException<a name="line.1025"></a>
<FONT color="green">1026</FONT>            {<a name="line.1026"></a>
<FONT color="green">1027</FONT>                for (int i = 0; i &lt; values.size(); i++)<a name="line.1027"></a>
<FONT color="green">1028</FONT>                {<a name="line.1028"></a>
<FONT color="green">1029</FONT>                    writeProperty(key, values.get(i));<a name="line.1029"></a>
<FONT color="green">1030</FONT>                }<a name="line.1030"></a>
<FONT color="green">1031</FONT>            }<a name="line.1031"></a>
<FONT color="green">1032</FONT>    <a name="line.1032"></a>
<FONT color="green">1033</FONT>            /**<a name="line.1033"></a>
<FONT color="green">1034</FONT>             * Writes the given property and its value. If the value happens to be a<a name="line.1034"></a>
<FONT color="green">1035</FONT>             * list, the {@code forceSingleLine} flag is evaluated. If it is<a name="line.1035"></a>
<FONT color="green">1036</FONT>             * set, all values are written on a single line using the list delimiter<a name="line.1036"></a>
<FONT color="green">1037</FONT>             * as separator.<a name="line.1037"></a>
<FONT color="green">1038</FONT>             *<a name="line.1038"></a>
<FONT color="green">1039</FONT>             * @param key the property key<a name="line.1039"></a>
<FONT color="green">1040</FONT>             * @param value the property value<a name="line.1040"></a>
<FONT color="green">1041</FONT>             * @param forceSingleLine the &amp;quot;force single line&amp;quot; flag<a name="line.1041"></a>
<FONT color="green">1042</FONT>             * @throws IOException if an error occurs<a name="line.1042"></a>
<FONT color="green">1043</FONT>             * @since 1.3<a name="line.1043"></a>
<FONT color="green">1044</FONT>             */<a name="line.1044"></a>
<FONT color="green">1045</FONT>            public void writeProperty(String key, Object value,<a name="line.1045"></a>
<FONT color="green">1046</FONT>                    boolean forceSingleLine) throws IOException<a name="line.1046"></a>
<FONT color="green">1047</FONT>            {<a name="line.1047"></a>
<FONT color="green">1048</FONT>                String v;<a name="line.1048"></a>
<FONT color="green">1049</FONT>    <a name="line.1049"></a>
<FONT color="green">1050</FONT>                if (value instanceof List)<a name="line.1050"></a>
<FONT color="green">1051</FONT>                {<a name="line.1051"></a>
<FONT color="green">1052</FONT>                    List&lt;?&gt; values = (List&lt;?&gt;) value;<a name="line.1052"></a>
<FONT color="green">1053</FONT>                    if (forceSingleLine)<a name="line.1053"></a>
<FONT color="green">1054</FONT>                    {<a name="line.1054"></a>
<FONT color="green">1055</FONT>                        v = makeSingleLineValue(values);<a name="line.1055"></a>
<FONT color="green">1056</FONT>                    }<a name="line.1056"></a>
<FONT color="green">1057</FONT>                    else<a name="line.1057"></a>
<FONT color="green">1058</FONT>                    {<a name="line.1058"></a>
<FONT color="green">1059</FONT>                        writeProperty(key, values);<a name="line.1059"></a>
<FONT color="green">1060</FONT>                        return;<a name="line.1060"></a>
<FONT color="green">1061</FONT>                    }<a name="line.1061"></a>
<FONT color="green">1062</FONT>                }<a name="line.1062"></a>
<FONT color="green">1063</FONT>                else<a name="line.1063"></a>
<FONT color="green">1064</FONT>                {<a name="line.1064"></a>
<FONT color="green">1065</FONT>                    v = escapeValue(value, false);<a name="line.1065"></a>
<FONT color="green">1066</FONT>                }<a name="line.1066"></a>
<FONT color="green">1067</FONT>    <a name="line.1067"></a>
<FONT color="green">1068</FONT>                write(escapeKey(key));<a name="line.1068"></a>
<FONT color="green">1069</FONT>                write(fetchSeparator(key, value));<a name="line.1069"></a>
<FONT color="green">1070</FONT>                write(v);<a name="line.1070"></a>
<FONT color="green">1071</FONT>    <a name="line.1071"></a>
<FONT color="green">1072</FONT>                writeln(null);<a name="line.1072"></a>
<FONT color="green">1073</FONT>            }<a name="line.1073"></a>
<FONT color="green">1074</FONT>    <a name="line.1074"></a>
<FONT color="green">1075</FONT>            /**<a name="line.1075"></a>
<FONT color="green">1076</FONT>             * Write a comment.<a name="line.1076"></a>
<FONT color="green">1077</FONT>             *<a name="line.1077"></a>
<FONT color="green">1078</FONT>             * @param comment the comment to write<a name="line.1078"></a>
<FONT color="green">1079</FONT>             * @throws IOException if an I/O error occurs<a name="line.1079"></a>
<FONT color="green">1080</FONT>             */<a name="line.1080"></a>
<FONT color="green">1081</FONT>            public void writeComment(String comment) throws IOException<a name="line.1081"></a>
<FONT color="green">1082</FONT>            {<a name="line.1082"></a>
<FONT color="green">1083</FONT>                writeln("# " + comment);<a name="line.1083"></a>
<FONT color="green">1084</FONT>            }<a name="line.1084"></a>
<FONT color="green">1085</FONT>    <a name="line.1085"></a>
<FONT color="green">1086</FONT>            /**<a name="line.1086"></a>
<FONT color="green">1087</FONT>             * Escape the separators in the key.<a name="line.1087"></a>
<FONT color="green">1088</FONT>             *<a name="line.1088"></a>
<FONT color="green">1089</FONT>             * @param key the key<a name="line.1089"></a>
<FONT color="green">1090</FONT>             * @return the escaped key<a name="line.1090"></a>
<FONT color="green">1091</FONT>             * @since 1.2<a name="line.1091"></a>
<FONT color="green">1092</FONT>             */<a name="line.1092"></a>
<FONT color="green">1093</FONT>            private String escapeKey(String key)<a name="line.1093"></a>
<FONT color="green">1094</FONT>            {<a name="line.1094"></a>
<FONT color="green">1095</FONT>                StringBuilder newkey = new StringBuilder();<a name="line.1095"></a>
<FONT color="green">1096</FONT>    <a name="line.1096"></a>
<FONT color="green">1097</FONT>                for (int i = 0; i &lt; key.length(); i++)<a name="line.1097"></a>
<FONT color="green">1098</FONT>                {<a name="line.1098"></a>
<FONT color="green">1099</FONT>                    char c = key.charAt(i);<a name="line.1099"></a>
<FONT color="green">1100</FONT>    <a name="line.1100"></a>
<FONT color="green">1101</FONT>                    if (ArrayUtils.contains(SEPARATORS, c) || ArrayUtils.contains(WHITE_SPACE, c))<a name="line.1101"></a>
<FONT color="green">1102</FONT>                    {<a name="line.1102"></a>
<FONT color="green">1103</FONT>                        // escape the separator<a name="line.1103"></a>
<FONT color="green">1104</FONT>                        newkey.append('\\');<a name="line.1104"></a>
<FONT color="green">1105</FONT>                        newkey.append(c);<a name="line.1105"></a>
<FONT color="green">1106</FONT>                    }<a name="line.1106"></a>
<FONT color="green">1107</FONT>                    else<a name="line.1107"></a>
<FONT color="green">1108</FONT>                    {<a name="line.1108"></a>
<FONT color="green">1109</FONT>                        newkey.append(c);<a name="line.1109"></a>
<FONT color="green">1110</FONT>                    }<a name="line.1110"></a>
<FONT color="green">1111</FONT>                }<a name="line.1111"></a>
<FONT color="green">1112</FONT>    <a name="line.1112"></a>
<FONT color="green">1113</FONT>                return newkey.toString();<a name="line.1113"></a>
<FONT color="green">1114</FONT>            }<a name="line.1114"></a>
<FONT color="green">1115</FONT>    <a name="line.1115"></a>
<FONT color="green">1116</FONT>            /**<a name="line.1116"></a>
<FONT color="green">1117</FONT>             * Escapes the given property value. Delimiter characters in the value<a name="line.1117"></a>
<FONT color="green">1118</FONT>             * will be escaped.<a name="line.1118"></a>
<FONT color="green">1119</FONT>             *<a name="line.1119"></a>
<FONT color="green">1120</FONT>             * @param value the property value<a name="line.1120"></a>
<FONT color="green">1121</FONT>             * @param inList a flag whether the value is part of a list<a name="line.1121"></a>
<FONT color="green">1122</FONT>             * @return the escaped property value<a name="line.1122"></a>
<FONT color="green">1123</FONT>             * @since 1.3<a name="line.1123"></a>
<FONT color="green">1124</FONT>             */<a name="line.1124"></a>
<FONT color="green">1125</FONT>            private String escapeValue(Object value, boolean inList)<a name="line.1125"></a>
<FONT color="green">1126</FONT>            {<a name="line.1126"></a>
<FONT color="green">1127</FONT>                String escapedValue = handleBackslashs(value, inList);<a name="line.1127"></a>
<FONT color="green">1128</FONT>                if (delimiter != 0)<a name="line.1128"></a>
<FONT color="green">1129</FONT>                {<a name="line.1129"></a>
<FONT color="green">1130</FONT>                    escapedValue = StringUtils.replace(escapedValue, String.valueOf(delimiter), ESCAPE + delimiter);<a name="line.1130"></a>
<FONT color="green">1131</FONT>                }<a name="line.1131"></a>
<FONT color="green">1132</FONT>                return escapedValue;<a name="line.1132"></a>
<FONT color="green">1133</FONT>            }<a name="line.1133"></a>
<FONT color="green">1134</FONT>    <a name="line.1134"></a>
<FONT color="green">1135</FONT>            /**<a name="line.1135"></a>
<FONT color="green">1136</FONT>             * Performs the escaping of backslashes in the specified properties<a name="line.1136"></a>
<FONT color="green">1137</FONT>             * value. Because a double backslash is used to escape the escape<a name="line.1137"></a>
<FONT color="green">1138</FONT>             * character of a list delimiter, double backslashes also have to be<a name="line.1138"></a>
<FONT color="green">1139</FONT>             * escaped if the property is part of a (single line) list. Then, in all<a name="line.1139"></a>
<FONT color="green">1140</FONT>             * cases each backslash has to be doubled in order to produce a valid<a name="line.1140"></a>
<FONT color="green">1141</FONT>             * properties file.<a name="line.1141"></a>
<FONT color="green">1142</FONT>             *<a name="line.1142"></a>
<FONT color="green">1143</FONT>             * @param value the value to be escaped<a name="line.1143"></a>
<FONT color="green">1144</FONT>             * @param inList a flag whether the value is part of a list<a name="line.1144"></a>
<FONT color="green">1145</FONT>             * @return the value with escaped backslashes as string<a name="line.1145"></a>
<FONT color="green">1146</FONT>             */<a name="line.1146"></a>
<FONT color="green">1147</FONT>            private String handleBackslashs(Object value, boolean inList)<a name="line.1147"></a>
<FONT color="green">1148</FONT>            {<a name="line.1148"></a>
<FONT color="green">1149</FONT>                String strValue = String.valueOf(value);<a name="line.1149"></a>
<FONT color="green">1150</FONT>    <a name="line.1150"></a>
<FONT color="green">1151</FONT>                if (inList &amp;&amp; strValue.indexOf(DOUBLE_ESC) &gt;= 0)<a name="line.1151"></a>
<FONT color="green">1152</FONT>                {<a name="line.1152"></a>
<FONT color="green">1153</FONT>                    char esc = ESCAPE.charAt(0);<a name="line.1153"></a>
<FONT color="green">1154</FONT>                    StringBuilder buf = new StringBuilder(strValue.length() + BUF_SIZE);<a name="line.1154"></a>
<FONT color="green">1155</FONT>                    for (int i = 0; i &lt; strValue.length(); i++)<a name="line.1155"></a>
<FONT color="green">1156</FONT>                    {<a name="line.1156"></a>
<FONT color="green">1157</FONT>                        if (strValue.charAt(i) == esc &amp;&amp; i &lt; strValue.length() - 1<a name="line.1157"></a>
<FONT color="green">1158</FONT>                                &amp;&amp; strValue.charAt(i + 1) == esc)<a name="line.1158"></a>
<FONT color="green">1159</FONT>                        {<a name="line.1159"></a>
<FONT color="green">1160</FONT>                            buf.append(DOUBLE_ESC).append(DOUBLE_ESC);<a name="line.1160"></a>
<FONT color="green">1161</FONT>                            i++;<a name="line.1161"></a>
<FONT color="green">1162</FONT>                        }<a name="line.1162"></a>
<FONT color="green">1163</FONT>                        else<a name="line.1163"></a>
<FONT color="green">1164</FONT>                        {<a name="line.1164"></a>
<FONT color="green">1165</FONT>                            buf.append(strValue.charAt(i));<a name="line.1165"></a>
<FONT color="green">1166</FONT>                        }<a name="line.1166"></a>
<FONT color="green">1167</FONT>                    }<a name="line.1167"></a>
<FONT color="green">1168</FONT>    <a name="line.1168"></a>
<FONT color="green">1169</FONT>                    strValue = buf.toString();<a name="line.1169"></a>
<FONT color="green">1170</FONT>                }<a name="line.1170"></a>
<FONT color="green">1171</FONT>    <a name="line.1171"></a>
<FONT color="green">1172</FONT>                return StringEscapeUtils.escapeJava(strValue);<a name="line.1172"></a>
<FONT color="green">1173</FONT>            }<a name="line.1173"></a>
<FONT color="green">1174</FONT>    <a name="line.1174"></a>
<FONT color="green">1175</FONT>            /**<a name="line.1175"></a>
<FONT color="green">1176</FONT>             * Transforms a list of values into a single line value.<a name="line.1176"></a>
<FONT color="green">1177</FONT>             *<a name="line.1177"></a>
<FONT color="green">1178</FONT>             * @param values the list with the values<a name="line.1178"></a>
<FONT color="green">1179</FONT>             * @return a string with the single line value (can be &lt;b&gt;null&lt;/b&gt;)<a name="line.1179"></a>
<FONT color="green">1180</FONT>             * @since 1.3<a name="line.1180"></a>
<FONT color="green">1181</FONT>             */<a name="line.1181"></a>
<FONT color="green">1182</FONT>            private String makeSingleLineValue(List&lt;?&gt; values)<a name="line.1182"></a>
<FONT color="green">1183</FONT>            {<a name="line.1183"></a>
<FONT color="green">1184</FONT>                if (!values.isEmpty())<a name="line.1184"></a>
<FONT color="green">1185</FONT>                {<a name="line.1185"></a>
<FONT color="green">1186</FONT>                    Iterator&lt;?&gt; it = values.iterator();<a name="line.1186"></a>
<FONT color="green">1187</FONT>                    String lastValue = escapeValue(it.next(), true);<a name="line.1187"></a>
<FONT color="green">1188</FONT>                    StringBuilder buf = new StringBuilder(lastValue);<a name="line.1188"></a>
<FONT color="green">1189</FONT>                    while (it.hasNext())<a name="line.1189"></a>
<FONT color="green">1190</FONT>                    {<a name="line.1190"></a>
<FONT color="green">1191</FONT>                        // if the last value ended with an escape character, it has<a name="line.1191"></a>
<FONT color="green">1192</FONT>                        // to be escaped itself; otherwise the list delimiter will<a name="line.1192"></a>
<FONT color="green">1193</FONT>                        // be escaped<a name="line.1193"></a>
<FONT color="green">1194</FONT>                        if (lastValue.endsWith(ESCAPE) &amp;&amp; (countTrailingBS(lastValue) / 2) % 2 != 0)<a name="line.1194"></a>
<FONT color="green">1195</FONT>                        {<a name="line.1195"></a>
<FONT color="green">1196</FONT>                            buf.append(ESCAPE).append(ESCAPE);<a name="line.1196"></a>
<FONT color="green">1197</FONT>                        }<a name="line.1197"></a>
<FONT color="green">1198</FONT>                        buf.append(delimiter);<a name="line.1198"></a>
<FONT color="green">1199</FONT>                        lastValue = escapeValue(it.next(), true);<a name="line.1199"></a>
<FONT color="green">1200</FONT>                        buf.append(lastValue);<a name="line.1200"></a>
<FONT color="green">1201</FONT>                    }<a name="line.1201"></a>
<FONT color="green">1202</FONT>                    return buf.toString();<a name="line.1202"></a>
<FONT color="green">1203</FONT>                }<a name="line.1203"></a>
<FONT color="green">1204</FONT>                else<a name="line.1204"></a>
<FONT color="green">1205</FONT>                {<a name="line.1205"></a>
<FONT color="green">1206</FONT>                    return null;<a name="line.1206"></a>
<FONT color="green">1207</FONT>                }<a name="line.1207"></a>
<FONT color="green">1208</FONT>            }<a name="line.1208"></a>
<FONT color="green">1209</FONT>    <a name="line.1209"></a>
<FONT color="green">1210</FONT>            /**<a name="line.1210"></a>
<FONT color="green">1211</FONT>             * Helper method for writing a line with the platform specific line<a name="line.1211"></a>
<FONT color="green">1212</FONT>             * ending.<a name="line.1212"></a>
<FONT color="green">1213</FONT>             *<a name="line.1213"></a>
<FONT color="green">1214</FONT>             * @param s the content of the line (may be &lt;b&gt;null&lt;/b&gt;)<a name="line.1214"></a>
<FONT color="green">1215</FONT>             * @throws IOException if an error occurs<a name="line.1215"></a>
<FONT color="green">1216</FONT>             * @since 1.3<a name="line.1216"></a>
<FONT color="green">1217</FONT>             */<a name="line.1217"></a>
<FONT color="green">1218</FONT>            public void writeln(String s) throws IOException<a name="line.1218"></a>
<FONT color="green">1219</FONT>            {<a name="line.1219"></a>
<FONT color="green">1220</FONT>                if (s != null)<a name="line.1220"></a>
<FONT color="green">1221</FONT>                {<a name="line.1221"></a>
<FONT color="green">1222</FONT>                    write(s);<a name="line.1222"></a>
<FONT color="green">1223</FONT>                }<a name="line.1223"></a>
<FONT color="green">1224</FONT>                write(getLineSeparator());<a name="line.1224"></a>
<FONT color="green">1225</FONT>            }<a name="line.1225"></a>
<FONT color="green">1226</FONT>    <a name="line.1226"></a>
<FONT color="green">1227</FONT>            /**<a name="line.1227"></a>
<FONT color="green">1228</FONT>             * Returns the separator to be used for the given property. This method<a name="line.1228"></a>
<FONT color="green">1229</FONT>             * is called by {@code writeProperty()}. The string returned here<a name="line.1229"></a>
<FONT color="green">1230</FONT>             * is used as separator between the property key and its value. Per<a name="line.1230"></a>
<FONT color="green">1231</FONT>             * default the method checks whether a global separator is set. If this<a name="line.1231"></a>
<FONT color="green">1232</FONT>             * is the case, it is returned. Otherwise the separator returned by<a name="line.1232"></a>
<FONT color="green">1233</FONT>             * {@code getCurrentSeparator()} is used, which was set by the<a name="line.1233"></a>
<FONT color="green">1234</FONT>             * associated layout object. Derived classes may implement a different<a name="line.1234"></a>
<FONT color="green">1235</FONT>             * strategy for defining the separator.<a name="line.1235"></a>
<FONT color="green">1236</FONT>             *<a name="line.1236"></a>
<FONT color="green">1237</FONT>             * @param key the property key<a name="line.1237"></a>
<FONT color="green">1238</FONT>             * @param value the value<a name="line.1238"></a>
<FONT color="green">1239</FONT>             * @return the separator to be used<a name="line.1239"></a>
<FONT color="green">1240</FONT>             * @since 1.7<a name="line.1240"></a>
<FONT color="green">1241</FONT>             */<a name="line.1241"></a>
<FONT color="green">1242</FONT>            protected String fetchSeparator(String key, Object value)<a name="line.1242"></a>
<FONT color="green">1243</FONT>            {<a name="line.1243"></a>
<FONT color="green">1244</FONT>                return (getGlobalSeparator() != null) ? getGlobalSeparator()<a name="line.1244"></a>
<FONT color="green">1245</FONT>                        : getCurrentSeparator();<a name="line.1245"></a>
<FONT color="green">1246</FONT>            }<a name="line.1246"></a>
<FONT color="green">1247</FONT>        } // class PropertiesWriter<a name="line.1247"></a>
<FONT color="green">1248</FONT>    <a name="line.1248"></a>
<FONT color="green">1249</FONT>        /**<a name="line.1249"></a>
<FONT color="green">1250</FONT>         * &lt;p&gt;<a name="line.1250"></a>
<FONT color="green">1251</FONT>         * Definition of an interface that allows customization of read and write<a name="line.1251"></a>
<FONT color="green">1252</FONT>         * operations.<a name="line.1252"></a>
<FONT color="green">1253</FONT>         * &lt;/p&gt;<a name="line.1253"></a>
<FONT color="green">1254</FONT>         * &lt;p&gt;<a name="line.1254"></a>
<FONT color="green">1255</FONT>         * For reading and writing properties files the inner classes<a name="line.1255"></a>
<FONT color="green">1256</FONT>         * {@code PropertiesReader} and {@code PropertiesWriter} are used.<a name="line.1256"></a>
<FONT color="green">1257</FONT>         * This interface defines factory methods for creating both a<a name="line.1257"></a>
<FONT color="green">1258</FONT>         * {@code PropertiesReader} and a {@code PropertiesWriter}. An<a name="line.1258"></a>
<FONT color="green">1259</FONT>         * object implementing this interface can be passed to the<a name="line.1259"></a>
<FONT color="green">1260</FONT>         * {@code setIOFactory()} method of<a name="line.1260"></a>
<FONT color="green">1261</FONT>         * {@code PropertiesConfiguration}. Every time the configuration is<a name="line.1261"></a>
<FONT color="green">1262</FONT>         * read or written the {@code IOFactory} is asked to create the<a name="line.1262"></a>
<FONT color="green">1263</FONT>         * appropriate reader or writer object. This provides an opportunity to<a name="line.1263"></a>
<FONT color="green">1264</FONT>         * inject custom reader or writer implementations.<a name="line.1264"></a>
<FONT color="green">1265</FONT>         * &lt;/p&gt;<a name="line.1265"></a>
<FONT color="green">1266</FONT>         *<a name="line.1266"></a>
<FONT color="green">1267</FONT>         * @since 1.7<a name="line.1267"></a>
<FONT color="green">1268</FONT>         */<a name="line.1268"></a>
<FONT color="green">1269</FONT>        public interface IOFactory<a name="line.1269"></a>
<FONT color="green">1270</FONT>        {<a name="line.1270"></a>
<FONT color="green">1271</FONT>            /**<a name="line.1271"></a>
<FONT color="green">1272</FONT>             * Creates a {@code PropertiesReader} for reading a properties<a name="line.1272"></a>
<FONT color="green">1273</FONT>             * file. This method is called whenever the<a name="line.1273"></a>
<FONT color="green">1274</FONT>             * {@code PropertiesConfiguration} is loaded. The reader returned<a name="line.1274"></a>
<FONT color="green">1275</FONT>             * by this method is then used for parsing the properties file.<a name="line.1275"></a>
<FONT color="green">1276</FONT>             *<a name="line.1276"></a>
<FONT color="green">1277</FONT>             * @param in the underlying reader (of the properties file)<a name="line.1277"></a>
<FONT color="green">1278</FONT>             * @param delimiter the delimiter character for list parsing<a name="line.1278"></a>
<FONT color="green">1279</FONT>             * @return the {@code PropertiesReader} for loading the<a name="line.1279"></a>
<FONT color="green">1280</FONT>             *         configuration<a name="line.1280"></a>
<FONT color="green">1281</FONT>             */<a name="line.1281"></a>
<FONT color="green">1282</FONT>            PropertiesReader createPropertiesReader(Reader in, char delimiter);<a name="line.1282"></a>
<FONT color="green">1283</FONT>    <a name="line.1283"></a>
<FONT color="green">1284</FONT>            /**<a name="line.1284"></a>
<FONT color="green">1285</FONT>             * Creates a {@code PropertiesWriter} for writing a properties<a name="line.1285"></a>
<FONT color="green">1286</FONT>             * file. This method is called before the<a name="line.1286"></a>
<FONT color="green">1287</FONT>             * {@code PropertiesConfiguration} is saved. The writer returned by<a name="line.1287"></a>
<FONT color="green">1288</FONT>             * this method is then used for writing the properties file.<a name="line.1288"></a>
<FONT color="green">1289</FONT>             *<a name="line.1289"></a>
<FONT color="green">1290</FONT>             * @param out the underlying writer (to the properties file)<a name="line.1290"></a>
<FONT color="green">1291</FONT>             * @param delimiter the delimiter character for list parsing<a name="line.1291"></a>
<FONT color="green">1292</FONT>             * @return the {@code PropertiesWriter} for saving the<a name="line.1292"></a>
<FONT color="green">1293</FONT>             *         configuration<a name="line.1293"></a>
<FONT color="green">1294</FONT>             */<a name="line.1294"></a>
<FONT color="green">1295</FONT>            PropertiesWriter createPropertiesWriter(Writer out, char delimiter);<a name="line.1295"></a>
<FONT color="green">1296</FONT>        }<a name="line.1296"></a>
<FONT color="green">1297</FONT>    <a name="line.1297"></a>
<FONT color="green">1298</FONT>        /**<a name="line.1298"></a>
<FONT color="green">1299</FONT>         * &lt;p&gt;<a name="line.1299"></a>
<FONT color="green">1300</FONT>         * A default implementation of the {@code IOFactory} interface.<a name="line.1300"></a>
<FONT color="green">1301</FONT>         * &lt;/p&gt;<a name="line.1301"></a>
<FONT color="green">1302</FONT>         * &lt;p&gt;<a name="line.1302"></a>
<FONT color="green">1303</FONT>         * This class implements the {@code createXXXX()} methods defined by<a name="line.1303"></a>
<FONT color="green">1304</FONT>         * the {@code IOFactory} interface in a way that the default objects<a name="line.1304"></a>
<FONT color="green">1305</FONT>         * (i.e. {@code PropertiesReader} and {@code PropertiesWriter} are<a name="line.1305"></a>
<FONT color="green">1306</FONT>         * returned. Customizing either the reader or the writer (or both) can be<a name="line.1306"></a>
<FONT color="green">1307</FONT>         * done by extending this class and overriding the corresponding<a name="line.1307"></a>
<FONT color="green">1308</FONT>         * {@code createXXXX()} method.<a name="line.1308"></a>
<FONT color="green">1309</FONT>         * &lt;/p&gt;<a name="line.1309"></a>
<FONT color="green">1310</FONT>         *<a name="line.1310"></a>
<FONT color="green">1311</FONT>         * @since 1.7<a name="line.1311"></a>
<FONT color="green">1312</FONT>         */<a name="line.1312"></a>
<FONT color="green">1313</FONT>        public static class DefaultIOFactory implements IOFactory<a name="line.1313"></a>
<FONT color="green">1314</FONT>        {<a name="line.1314"></a>
<FONT color="green">1315</FONT>            public PropertiesReader createPropertiesReader(Reader in, char delimiter)<a name="line.1315"></a>
<FONT color="green">1316</FONT>            {<a name="line.1316"></a>
<FONT color="green">1317</FONT>                return new PropertiesReader(in, delimiter);<a name="line.1317"></a>
<FONT color="green">1318</FONT>            }<a name="line.1318"></a>
<FONT color="green">1319</FONT>    <a name="line.1319"></a>
<FONT color="green">1320</FONT>            public PropertiesWriter createPropertiesWriter(Writer out,<a name="line.1320"></a>
<FONT color="green">1321</FONT>                    char delimiter)<a name="line.1321"></a>
<FONT color="green">1322</FONT>            {<a name="line.1322"></a>
<FONT color="green">1323</FONT>                return new PropertiesWriter(out, delimiter);<a name="line.1323"></a>
<FONT color="green">1324</FONT>            }<a name="line.1324"></a>
<FONT color="green">1325</FONT>        }<a name="line.1325"></a>
<FONT color="green">1326</FONT>    <a name="line.1326"></a>
<FONT color="green">1327</FONT>        /**<a name="line.1327"></a>
<FONT color="green">1328</FONT>         * &lt;p&gt;Unescapes any Java literals found in the {@code String} to a<a name="line.1328"></a>
<FONT color="green">1329</FONT>         * {@code Writer}.&lt;/p&gt; This is a slightly modified version of the<a name="line.1329"></a>
<FONT color="green">1330</FONT>         * StringEscapeUtils.unescapeJava() function in commons-lang that doesn't<a name="line.1330"></a>
<FONT color="green">1331</FONT>         * drop escaped separators (i.e '\,').<a name="line.1331"></a>
<FONT color="green">1332</FONT>         *<a name="line.1332"></a>
<FONT color="green">1333</FONT>         * @param str  the {@code String} to unescape, may be null<a name="line.1333"></a>
<FONT color="green">1334</FONT>         * @param delimiter the delimiter for multi-valued properties<a name="line.1334"></a>
<FONT color="green">1335</FONT>         * @return the processed string<a name="line.1335"></a>
<FONT color="green">1336</FONT>         * @throws IllegalArgumentException if the Writer is {@code null}<a name="line.1336"></a>
<FONT color="green">1337</FONT>         */<a name="line.1337"></a>
<FONT color="green">1338</FONT>        protected static String unescapeJava(String str, char delimiter)<a name="line.1338"></a>
<FONT color="green">1339</FONT>        {<a name="line.1339"></a>
<FONT color="green">1340</FONT>            if (str == null)<a name="line.1340"></a>
<FONT color="green">1341</FONT>            {<a name="line.1341"></a>
<FONT color="green">1342</FONT>                return null;<a name="line.1342"></a>
<FONT color="green">1343</FONT>            }<a name="line.1343"></a>
<FONT color="green">1344</FONT>            int sz = str.length();<a name="line.1344"></a>
<FONT color="green">1345</FONT>            StringBuilder out = new StringBuilder(sz);<a name="line.1345"></a>
<FONT color="green">1346</FONT>            StringBuilder unicode = new StringBuilder(UNICODE_LEN);<a name="line.1346"></a>
<FONT color="green">1347</FONT>            boolean hadSlash = false;<a name="line.1347"></a>
<FONT color="green">1348</FONT>            boolean inUnicode = false;<a name="line.1348"></a>
<FONT color="green">1349</FONT>            for (int i = 0; i &lt; sz; i++)<a name="line.1349"></a>
<FONT color="green">1350</FONT>            {<a name="line.1350"></a>
<FONT color="green">1351</FONT>                char ch = str.charAt(i);<a name="line.1351"></a>
<FONT color="green">1352</FONT>                if (inUnicode)<a name="line.1352"></a>
<FONT color="green">1353</FONT>                {<a name="line.1353"></a>
<FONT color="green">1354</FONT>                    // if in unicode, then we're reading unicode<a name="line.1354"></a>
<FONT color="green">1355</FONT>                    // values in somehow<a name="line.1355"></a>
<FONT color="green">1356</FONT>                    unicode.append(ch);<a name="line.1356"></a>
<FONT color="green">1357</FONT>                    if (unicode.length() == UNICODE_LEN)<a name="line.1357"></a>
<FONT color="green">1358</FONT>                    {<a name="line.1358"></a>
<FONT color="green">1359</FONT>                        // unicode now contains the four hex digits<a name="line.1359"></a>
<FONT color="green">1360</FONT>                        // which represents our unicode character<a name="line.1360"></a>
<FONT color="green">1361</FONT>                        try<a name="line.1361"></a>
<FONT color="green">1362</FONT>                        {<a name="line.1362"></a>
<FONT color="green">1363</FONT>                            int value = Integer.parseInt(unicode.toString(), HEX_RADIX);<a name="line.1363"></a>
<FONT color="green">1364</FONT>                            out.append((char) value);<a name="line.1364"></a>
<FONT color="green">1365</FONT>                            unicode.setLength(0);<a name="line.1365"></a>
<FONT color="green">1366</FONT>                            inUnicode = false;<a name="line.1366"></a>
<FONT color="green">1367</FONT>                            hadSlash = false;<a name="line.1367"></a>
<FONT color="green">1368</FONT>                        }<a name="line.1368"></a>
<FONT color="green">1369</FONT>                        catch (NumberFormatException nfe)<a name="line.1369"></a>
<FONT color="green">1370</FONT>                        {<a name="line.1370"></a>
<FONT color="green">1371</FONT>                            throw new ConfigurationRuntimeException("Unable to parse unicode value: " + unicode, nfe);<a name="line.1371"></a>
<FONT color="green">1372</FONT>                        }<a name="line.1372"></a>
<FONT color="green">1373</FONT>                    }<a name="line.1373"></a>
<FONT color="green">1374</FONT>                    continue;<a name="line.1374"></a>
<FONT color="green">1375</FONT>                }<a name="line.1375"></a>
<FONT color="green">1376</FONT>    <a name="line.1376"></a>
<FONT color="green">1377</FONT>                if (hadSlash)<a name="line.1377"></a>
<FONT color="green">1378</FONT>                {<a name="line.1378"></a>
<FONT color="green">1379</FONT>                    // handle an escaped value<a name="line.1379"></a>
<FONT color="green">1380</FONT>                    hadSlash = false;<a name="line.1380"></a>
<FONT color="green">1381</FONT>    <a name="line.1381"></a>
<FONT color="green">1382</FONT>                    if (ch == '\\')<a name="line.1382"></a>
<FONT color="green">1383</FONT>                    {<a name="line.1383"></a>
<FONT color="green">1384</FONT>                        out.append('\\');<a name="line.1384"></a>
<FONT color="green">1385</FONT>                    }<a name="line.1385"></a>
<FONT color="green">1386</FONT>                    else if (ch == '\'')<a name="line.1386"></a>
<FONT color="green">1387</FONT>                    {<a name="line.1387"></a>
<FONT color="green">1388</FONT>                        out.append('\'');<a name="line.1388"></a>
<FONT color="green">1389</FONT>                    }<a name="line.1389"></a>
<FONT color="green">1390</FONT>                    else if (ch == '\"')<a name="line.1390"></a>
<FONT color="green">1391</FONT>                    {<a name="line.1391"></a>
<FONT color="green">1392</FONT>                        out.append('"');<a name="line.1392"></a>
<FONT color="green">1393</FONT>                    }<a name="line.1393"></a>
<FONT color="green">1394</FONT>                    else if (ch == 'r')<a name="line.1394"></a>
<FONT color="green">1395</FONT>                    {<a name="line.1395"></a>
<FONT color="green">1396</FONT>                        out.append('\r');<a name="line.1396"></a>
<FONT color="green">1397</FONT>                    }<a name="line.1397"></a>
<FONT color="green">1398</FONT>                    else if (ch == 'f')<a name="line.1398"></a>
<FONT color="green">1399</FONT>                    {<a name="line.1399"></a>
<FONT color="green">1400</FONT>                        out.append('\f');<a name="line.1400"></a>
<FONT color="green">1401</FONT>                    }<a name="line.1401"></a>
<FONT color="green">1402</FONT>                    else if (ch == 't')<a name="line.1402"></a>
<FONT color="green">1403</FONT>                    {<a name="line.1403"></a>
<FONT color="green">1404</FONT>                        out.append('\t');<a name="line.1404"></a>
<FONT color="green">1405</FONT>                    }<a name="line.1405"></a>
<FONT color="green">1406</FONT>                    else if (ch == 'n')<a name="line.1406"></a>
<FONT color="green">1407</FONT>                    {<a name="line.1407"></a>
<FONT color="green">1408</FONT>                        out.append('\n');<a name="line.1408"></a>
<FONT color="green">1409</FONT>                    }<a name="line.1409"></a>
<FONT color="green">1410</FONT>                    else if (ch == 'b')<a name="line.1410"></a>
<FONT color="green">1411</FONT>                    {<a name="line.1411"></a>
<FONT color="green">1412</FONT>                        out.append('\b');<a name="line.1412"></a>
<FONT color="green">1413</FONT>                    }<a name="line.1413"></a>
<FONT color="green">1414</FONT>                    else if (ch == delimiter)<a name="line.1414"></a>
<FONT color="green">1415</FONT>                    {<a name="line.1415"></a>
<FONT color="green">1416</FONT>                        out.append('\\');<a name="line.1416"></a>
<FONT color="green">1417</FONT>                        out.append(delimiter);<a name="line.1417"></a>
<FONT color="green">1418</FONT>                    }<a name="line.1418"></a>
<FONT color="green">1419</FONT>                    else if (ch == 'u')<a name="line.1419"></a>
<FONT color="green">1420</FONT>                    {<a name="line.1420"></a>
<FONT color="green">1421</FONT>                        // uh-oh, we're in unicode country....<a name="line.1421"></a>
<FONT color="green">1422</FONT>                        inUnicode = true;<a name="line.1422"></a>
<FONT color="green">1423</FONT>                    }<a name="line.1423"></a>
<FONT color="green">1424</FONT>                    else<a name="line.1424"></a>
<FONT color="green">1425</FONT>                    {<a name="line.1425"></a>
<FONT color="green">1426</FONT>                        out.append(ch);<a name="line.1426"></a>
<FONT color="green">1427</FONT>                    }<a name="line.1427"></a>
<FONT color="green">1428</FONT>    <a name="line.1428"></a>
<FONT color="green">1429</FONT>                    continue;<a name="line.1429"></a>
<FONT color="green">1430</FONT>                }<a name="line.1430"></a>
<FONT color="green">1431</FONT>                else if (ch == '\\')<a name="line.1431"></a>
<FONT color="green">1432</FONT>                {<a name="line.1432"></a>
<FONT color="green">1433</FONT>                    hadSlash = true;<a name="line.1433"></a>
<FONT color="green">1434</FONT>                    continue;<a name="line.1434"></a>
<FONT color="green">1435</FONT>                }<a name="line.1435"></a>
<FONT color="green">1436</FONT>                out.append(ch);<a name="line.1436"></a>
<FONT color="green">1437</FONT>            }<a name="line.1437"></a>
<FONT color="green">1438</FONT>    <a name="line.1438"></a>
<FONT color="green">1439</FONT>            if (hadSlash)<a name="line.1439"></a>
<FONT color="green">1440</FONT>            {<a name="line.1440"></a>
<FONT color="green">1441</FONT>                // then we're in the weird case of a \ at the end of the<a name="line.1441"></a>
<FONT color="green">1442</FONT>                // string, let's output it anyway.<a name="line.1442"></a>
<FONT color="green">1443</FONT>                out.append('\\');<a name="line.1443"></a>
<FONT color="green">1444</FONT>            }<a name="line.1444"></a>
<FONT color="green">1445</FONT>    <a name="line.1445"></a>
<FONT color="green">1446</FONT>            return out.toString();<a name="line.1446"></a>
<FONT color="green">1447</FONT>        }<a name="line.1447"></a>
<FONT color="green">1448</FONT>    <a name="line.1448"></a>
<FONT color="green">1449</FONT>        /**<a name="line.1449"></a>
<FONT color="green">1450</FONT>         * Helper method for loading an included properties file. This method is<a name="line.1450"></a>
<FONT color="green">1451</FONT>         * called by {@code load()} when an {@code include} property<a name="line.1451"></a>
<FONT color="green">1452</FONT>         * is encountered. It tries to resolve relative file names based on the<a name="line.1452"></a>
<FONT color="green">1453</FONT>         * current base path. If this fails, a resolution based on the location of<a name="line.1453"></a>
<FONT color="green">1454</FONT>         * this properties file is tried.<a name="line.1454"></a>
<FONT color="green">1455</FONT>         *<a name="line.1455"></a>
<FONT color="green">1456</FONT>         * @param fileName the name of the file to load<a name="line.1456"></a>
<FONT color="green">1457</FONT>         * @throws ConfigurationException if loading fails<a name="line.1457"></a>
<FONT color="green">1458</FONT>         */<a name="line.1458"></a>
<FONT color="green">1459</FONT>        private void loadIncludeFile(String fileName) throws ConfigurationException<a name="line.1459"></a>
<FONT color="green">1460</FONT>        {<a name="line.1460"></a>
<FONT color="green">1461</FONT>            URL url = ConfigurationUtils.locate(getFileSystem(), getBasePath(), fileName);<a name="line.1461"></a>
<FONT color="green">1462</FONT>            if (url == null)<a name="line.1462"></a>
<FONT color="green">1463</FONT>            {<a name="line.1463"></a>
<FONT color="green">1464</FONT>                URL baseURL = getURL();<a name="line.1464"></a>
<FONT color="green">1465</FONT>                if (baseURL != null)<a name="line.1465"></a>
<FONT color="green">1466</FONT>                {<a name="line.1466"></a>
<FONT color="green">1467</FONT>                    url = ConfigurationUtils.locate(getFileSystem(), baseURL.toString(), fileName);<a name="line.1467"></a>
<FONT color="green">1468</FONT>                }<a name="line.1468"></a>
<FONT color="green">1469</FONT>            }<a name="line.1469"></a>
<FONT color="green">1470</FONT>    <a name="line.1470"></a>
<FONT color="green">1471</FONT>            if (url == null)<a name="line.1471"></a>
<FONT color="green">1472</FONT>            {<a name="line.1472"></a>
<FONT color="green">1473</FONT>                throw new ConfigurationException("Cannot resolve include file "<a name="line.1473"></a>
<FONT color="green">1474</FONT>                        + fileName);<a name="line.1474"></a>
<FONT color="green">1475</FONT>            }<a name="line.1475"></a>
<FONT color="green">1476</FONT>            load(url);<a name="line.1476"></a>
<FONT color="green">1477</FONT>        }<a name="line.1477"></a>
<FONT color="green">1478</FONT>    }<a name="line.1478"></a>




























































</PRE>
</BODY>
</HTML>
